Skip to content

Commit

Permalink
release: v.0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Austin Culter committed Dec 7, 2018
1 parent 70cd248 commit 587a767
Show file tree
Hide file tree
Showing 34 changed files with 819 additions and 0 deletions.
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.5.1
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
9 changes: 9 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# frozen_string_literal: true

source 'https://rubygems.org'
ruby '2.5.1'

git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

# Specify your gem's dependencies in oomnitza.gemspec
gemspec
40 changes: 40 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
PATH
remote: .
specs:
oomnitza (0.1.0)
json

GEM
remote: https://rubygems.org/
specs:
diff-lcs (1.3)
json (2.1.0)
rake (10.5.0)
rspec (3.8.0)
rspec-core (~> 3.8.0)
rspec-expectations (~> 3.8.0)
rspec-mocks (~> 3.8.0)
rspec-core (3.8.0)
rspec-support (~> 3.8.0)
rspec-expectations (3.8.1)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.8.0)
rspec-mocks (3.8.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.8.0)
rspec-support (3.8.0)

PLATFORMS
ruby

DEPENDENCIES
bundler (~> 1.16)
oomnitza!
rake (~> 10.0)
rspec (~> 3.0)

RUBY VERSION
ruby 2.5.1p57

BUNDLED WITH
1.16.2
79 changes: 79 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Oomnitza

Ruby client library for Oomnitza's API.

## Installation

Add this line to your application's Gemfile:

gem 'oomnitza'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install oomnitza

## Usage

**USE AT YOUR OWN RISK!**

While best efforts have been made to test this gem, I do not take responsibility for any adverse actions that may be performed by it.

```
require 'oomnitza'
# Configure the client
Oomnitza::Client.configure(tenant: 'yourTeantHere', api_key: 'yourApiKeyHere')
# Return array of all assets (where each objects)
all_assets = Oomnitza::Api::Asset.all
# Create a new asset
Oomnitza::Api::Asset.create({order_number: '001', po_number: 'chefaustin001', invoice_number: '20181205_chefaustin001_001', manufacturer_1: 'Apple', purchase_price_1: '1234.56', serial_number: 'TEST12345', tracking_number: '1Z1234567890', model: 'MacBook Air 2.7GHz', status: 'Purchased', vendor: 'Apple Direct'})
# Find and delete an asset
asset = Oomnitza::Api::Asset.find('bbb5b60bb80f470b8b008b556300916b')
asset.delete!
# Return array of all software
softwares = Oomnitza::Api::Software.all
# Create new software record
Oomnitza::Api::Software.create({name: 'Microsoft SQL Express', license_key: 'foo123bar456', _license_seats: "5"})
# Modify software record
software = softwares[0]
software.modify({_license_seats: "100"})
# Delete software record by known software_id
Oomnitza::Api::Software.delete('a000a00bddaa0cf0ab0000000f0d00b0')
# Iterate through all users and output username, office.
all_users.each do |u|
puts "#{u.username} works at #{u.office}"
end
```

## Contributing

Improvements needing to be made:

- Error handling
- `.filter` assets function
- Child asset associations CRUD functions
- DRY-up many aspects of `client.rb`
- [Put a bird on it](https://www.youtube.com/watch?v=iHmLljk2t8M)

Bug reports and pull requests (preferred) are welcome on GitHub at https://github.com/chefaustin/oomnitza. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the project’s codebase and issue tracker is expected to follow the [code of conduct](https://github.com/chefaustin/oomnitza/blob/master/CODE_OF_CONDUCT.md).
8 changes: 8 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

require 'bundler/gem_tasks'
require 'rspec/core/rake_task'

RSpec::Core::RakeTask.new(:spec)

task :default => :spec
15 changes: 15 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env ruby
# frozen_string_literal: true

require 'bundler/setup'
require 'oomnitza'

# You can add fixtures and/or initialization code here to make experimenting
# with your gem easier. You can also use a different console, if you like.

# (If you use this, don't forget to add pry to your Gemfile!)
# require "pry"
# Pry.start

require 'irb'
IRB.start(__FILE__)
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx

bundle install

# Do any other automated setup that you need to do here
29 changes: 29 additions & 0 deletions lib/config.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# frozen_string_literal: true

# This is a top-level module documentation comment
module Oomnitza
# This is a top-level module documentation comment
module Config
extend self

attr_accessor :token
attr_accessor :logger

def reset
self.token = nil
self.logger = nil
end

reset
end

class << self
def configure
block_given? ? yield(Config) : Config
end

def config
Config
end
end
end
24 changes: 24 additions & 0 deletions lib/oomnitza.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# frozen_string_literal: true

require 'oomnitza/client/activity'
require 'oomnitza/client/asset'
require 'oomnitza/client/connector_run_log'
require 'oomnitza/client/contract'
require 'oomnitza/client/dashboard'
require 'oomnitza/client/license'
require 'oomnitza/client/location_workflow'
require 'oomnitza/client/location'
require 'oomnitza/client/populate_searchhelp'
require 'oomnitza/client/session'
require 'oomnitza/client/software'
require 'oomnitza/client/subscription'
require 'oomnitza/client/user'
require 'oomnitza/client/widget'
require 'oomnitza/client/widget_for_edit'
require 'oomnitza/version'
require 'net/http'
require 'json'

module Oomnitza
# Things go here; stuff, too.
end
Loading

0 comments on commit 587a767

Please sign in to comment.