unleashed 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 147bdc99b6e8ce42af1eb564d90374ccaa7ae220b41b3ccc5fed0fee3e23bb6e
-  data.tar.gz: b5f3fc37b96ee6c404c95e00b33822f8025015b6e2dbe781ec25711d469a1d5d
+  metadata.gz: b8cf451e716eaf53fdd1c508701a506625f9d10f62a26cb7298e8b32a9832dc0
+  data.tar.gz: ed27ce803188bbaf52c87161d5adff85a9706a7f96d836e688199b1e622d88b1
 SHA512:
-  metadata.gz: 334ecfd9f511222c578654b81e2a7054c16a7a2ed9f05b6b670e41119b8527c6cb714a024e5c56efb0a00fc1756f847d4b2285efccc0684ac1d5ae8211c0686a
-  data.tar.gz: c9534ae24edb3ec3b933f1cbb5dc47510883583d93f9d20ca197a757542efc6d17085e8bc2cae1863ba14f16fd9846b25e04caa224e3ac517003923ef7c8468d
+  metadata.gz: ce74137ff724c846b635cc790f0031143ceb8dbc40cccff2e2e8b5db1bbcf5ff8d6401063130022583a8e69c2feccbb6894471339e6d7857973754103c6bceb8
+  data.tar.gz: c23906fd924b35d65cca03a2df50cc88a09a8503a6708b16b379b9a238b92e88824042fa86b503c248de1005079f1ef86f03fe5de73987837bbfbfde08df26fe

data/.gitignore

@@ -7,6 +7,5 @@
 /spec/reports/
 /tmp/
 
-# rspec failure tracking
 .rspec_status
 Gemfile.lock

data/.rspec

@@ -1,3 +1,4 @@
+
 --format documentation
 --color
 --require spec_helper

data/.ruby-version

@@ -1 +1,2 @@
+
 2.5.0

data/.travis.yml

@@ -1,3 +1,4 @@
+
 sudo: false
 language: ruby
 rvm:

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+
 # Change Log
 
 All notable changes to this project will be documented in this file.

data/CODE_OF_CONDUCT.md

@@ -1,3 +1,4 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in unleashed.gemspec
+
 gemspec

data/LICENSE

@@ -1,3 +1,4 @@
+
 MIT License
 
 Copyright (c) 2019 Nathan

data/LICENSE.txt

@@ -1,3 +1,4 @@
+
 The MIT License (MIT)
 
 Copyright (c) 2019 Nhan Nguyen

data/README.md

@@ -18,11 +18,57 @@ Or install it yourself as:
 
     $ gem install unleashed
 
-## 2. Usage
+## 2. Configuration
 
-TODO: Write usage instructions here
+Before interacting with Unleashed API you need to sign up an account.
 
-## 3. Contributing
+See [Unleashed API Documentation](https://apidocs.unleashedsoftware.com/) for more information.
+
+### Create a Unleashed client
+
+The client can be configured through environment variables.
+
+```ruby
+# In your environment file
+# Default
+UNLEASHED_API_DOMAIN = api.unleashedsoftware.com
+UNLEASHED_CLIENT_TYPE_HEADER = API-Sandbox
+
+UNLEASHED_API_ID = yourapiid
+UNLEASHED_API_KEY = yourapikey
+```
+
+The following parameters are configurable through the client:
+
+* `:api_domain` / `ENV['UNLEASHED_API_DOMAIN']`: API domain name to use (default: 'api.unleashedsoftware.com')
+* `:api_id` / `ENV['UNLEASHED_API_ID']`: API ID
+* `:api_key` / `ENV['UNLEASHED_API_KEY']`: API KEY
+* `:client_type_header` / `ENV['UNLEASHED_CLIENT_TYPE_HEADER']`: Client Type Header to use (default: 'API-Sandbox')
+
+## 3. Usage
+
+### Instantiate the Unleashed client
+
+```ruby
+options = { api_id: ENV['UNLEASHED_API_ID'], api_key: ENV['UNLEASHED_API_KEY'] }
+client = Unleashed::Client.new(options)
+```
+
+### Customers
+
+#### Get all customers
+
+```ruby
+client.customers.all
+```
+
+#### Get a customer
+
+```ruby
+client.customers.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
+```
+
+## 4. Contributing
 
   1. Fork it [https://github.com/nnhansg/unleashed-ruby](https://github.com/nnhansg/unleashed-ruby)
   2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -30,10 +76,10 @@ TODO: Write usage instructions here
   4. Push to the branch (`git push origin my-new-feature`)
   5. Create a new Pull Request
 
-## 4. License
+## 5. License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## 5. Code of Conduct
+## 6. Code of Conduct
 
 Everyone interacting in the Unleashed project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nnhansg/unleashed-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,3 +1,4 @@
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/lib/unleashed/version.rb

@@ -2,7 +2,7 @@ module Unleashed
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY = 4
+    TINY = 5
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}".freeze
   end

data/unleashed.gemspec

@@ -1,3 +1,4 @@
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'unleashed/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unleashed
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nhan Nguyen
@@ -104,8 +104,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/.keep
 - bin/console
 - bin/setup
+- lib/.keep
 - lib/unleashed.rb
 - lib/unleashed/client.rb
 - lib/unleashed/configurable.rb