order_cloud 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c60c6d68377baa4b970890fe86366f47950db36
-  data.tar.gz: bd0c90e186550da2826b89169351a2906b70b180
+  metadata.gz: 4c7b3cff6308e2c4d8b355429fbfcdd56af63576
+  data.tar.gz: 4df681e2b92eefaf7b11bf2519774202fa3a4cd4
 SHA512:
-  metadata.gz: 4a03739d1aa3541febe833224e6b3adfd77d04f6fe9b953510d2e18ca3988b60aae9ab6aa8e9e0c2fd376b6d9c82a30781dcc11b1bfde301eea938184f15faec
-  data.tar.gz: 1446ed92c2bfc7087118f436e1dcb2ec8b0ed80b4ce1d34475efd54c56e633fcd94ed6241af68802a446aceefa387e61858834e854bf45de41e9df787471faf7
+  metadata.gz: d41e97378ca05c568cae330af17fda3a390a3bdc707c61f9604ad547c2c848efcc47a0d60c9b508f63005decef33e9c2e5e49899cf676e84e84123e3b38dc0a7
+  data.tar.gz: 26e2cc1041aa410217308ddb65500469cca49ef5ba8b53e64683dee330fce822e85359a9aa9837d1a595c86d2e8979d51ab8930178150d8a11a7875056c737e4

data/README.md

@@ -1,81 +1,78 @@
 # order_cloud
 
+## Introduction
+OrderCloud gem is an SDK for OrderCloud's API written in Ruby. All of the methods for the most part are a 1:1 reflection of the API. This guide will cover how to install and get started with OrderCloud Ruby gem.
 OrderCloud - the Ruby gem for the OrderCloud
 
-A full ecommerce backend as a service.
+## Acknowledgment
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0
-- Package version: 0.0.1
-- Build date: 2016-09-13T15:51:20.193-05:00
+- Package version: 0.0.2
+- Build date: 2016-09-14T11:33:46.332-05:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
 For more information, please visit [http://public.four51.com/](http://public.four51.com/)
 
+## Requirements
+- Ruby >= 2.3.0
+
 ## Installation
 
-### Build a gem
+Add this line to your `Gemfile`:
 
-To build the Ruby code into a gem:
+    gem 'order_cloud', '~> 0.0.2'
 
+Or run this in your terminal:
 ```shell
-gem build order_cloud.gemspec
+gem install order_cloud
 ```
 
-Then either install the gem locally:
-
-```shell
-gem install ./order_cloud-0.0.1.gem
-```
-(for development, run `gem install --dev ./order_cloud-0.0.1.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'order_cloud', '~> 0.0.1'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
-
-    gem 'order_cloud', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
+## Configuration
 
-```shell
-ruby -Ilib script.rb
-```
+You will need to provide the ClientID which identifies the Organization or Buyer Company you will be interacting with. The ClientID can be found in the application tab of your Dashboard. Check out this guide for more information. Once you have the ClientID you can configure it with the following function.
 
-## Getting Started
-
-Please follow the [installation](#installation) procedure and then run the following code:
 ```ruby
 # Load the gem
 require 'order_cloud'
 
 # Setup authorization
 OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
+  config.client_id = 'MY_CLIENT_ID'
+  config.scopes= ['MY_SCOPE']
 end
+```
 
-api_instance = OrderCloud::AddressApi.new
+## Authentication
 
-buyer_id = "buyer_id_example" # String | ID of the buyer.
+```ruby
+OrderCloud::ApiAuth::login('username', 'password')
+```
 
-address = OrderCloud::Address.new # Address | 
+## Impersonation
 
+```ruby
+user_instance = OrderCloud::UserApi.new
+impersonation_token = user_instance.get_access_token(buyer_id, user_id, { :claims => ['YOUR_CLAIM'] })
+
+OrderCloud::ApiAuth::start_impersonate(impersonation_token)
+puts 'Impersonation status: #{{{{moduleName}}}::Configuration.default.impersonation}'
+
+OrderCloud::ApiAuth::stop_impersonate
+puts 'Impersonation status: #{{{{moduleName}}}::Configuration.default.impersonation}'
+```
+
+## Example
+```ruby
+api_instance = OrderCloud::ProductApi.new
 
 begin
-  result = api_instance.create(buyer_id, address)
+  result = api_instance.list
   p result
 rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->create: #{e}"
+  puts "Exception when calling ProductApi->list: #{e}"
 end
-
 ```
 
 ## Documentation for API Endpoints

data/git_push.sh

@@ -23,17 +23,17 @@ git_repo_id=$2
 release_note=$3
 
 if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
+    git_user_id="ordercloud-api"
     echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
 fi
 
 if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
+    git_repo_id="ordercloud-ruby-sdk"
     echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
 fi
 
 if [ "$release_note" = "" ]; then
-    release_note="Minor update"
+    release_note="Added auth_url definition to configuration"
     echo "[INFO] No command line input provided. Set \$release_note to $release_note"
 fi
 

data/lib/order_cloud/configuration.rb

@@ -35,8 +35,9 @@ module OrderCloud
     def impersonating?
       !@impersonation_token.empty?
     end
+    u will need to provide the ClientID which identifies the Organization or Buyer Company you will be interacting with. The ClientID can be found in the application tab of your Dashboard. Check out this guide for more information. Once you have the ClientID you can configure it with the following function.
 
-    # Returns the appropriate token 
+    # Returns the appropriate token
     def get_access_token
       if impersonating?
         @impersonation_token
@@ -170,10 +171,10 @@ module OrderCloud
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
 
-      @auth_url
+      @auth_url = 'https://auth.ordercloud.io/oauth/token'
       @impersonation_token = ''
       @client_id = ''
-      @scopes = [] 
+      @scopes = []
 
       yield(self) if block_given?
     end

data/lib/order_cloud/version.rb

@@ -22,5 +22,5 @@ limitations under the License.
 =end
 
 module OrderCloud
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_cloud
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Le Cam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -621,7 +621,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem for the OrderCloud.io B2B eCommerce platform