codes_wholesale 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 894644b512026683ad3b25f4b33899aa96a074d4
-  data.tar.gz: 7b09b1e9fcd21c9075dc40c0d0d3e5fa41ef0a2b
+  metadata.gz: 1e2fbc78b949f214b64d39b6e256cc2ddcac7209
+  data.tar.gz: 9ba86498351d849ff36ab3c3886bfaf00e7aa3f6
 SHA512:
-  metadata.gz: 766957e807b104f3c671d36db1357d8332dcf945d094ae7af9e80d307c089e3df1a6fd8b89ddde139aeef5390bd03cd88f6a15f2d7a2b6534047767080f427b1
-  data.tar.gz: fb7dafb9ca8e891be68082dd2e8f4b81a587280c8615dd11e1fd4f23d6425c2a944c3093db520779fa03f9623277f3131b50895402a672f44db2abc4b2c1e6b2
+  metadata.gz: a4eb8cd10f39f51306f746595f233cf37852c8d08f2e48c2185eac30afb5722551973e89a719de6f427c705384e6ec1e0db5b06dc6612aac61779726b2c153dc
+  data.tar.gz: 01d4baf587a6309ccf3ef4ed58927f5ddf9eaa5e0b42ccbac5aeeaccd2ac61896c285b5b8cea6b163c90c0b179533ae95b3678f7ce53394eee984bdf5e093211

data/lib/codes_wholesale/client.rb

@@ -4,6 +4,10 @@ require 'codes_wholesale/client/products'
 require 'codes_wholesale/client/orders'
 
 module CodesWholesale
+
+  # Client for the CodesWholesale API
+  #
+  # @see https://docs.codeswholesale.com/api-documentation/
   class Client
     include CodesWholesale::Configurable
     include CodesWholesale::Client::Accounts
@@ -11,15 +15,22 @@ module CodesWholesale
     include CodesWholesale::Client::Orders
 
     def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
       CodesWholesale::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", options[key] || CodesWholesale.instance_variable_get(:"@#{key}"))
       end
     end
 
+    # Authenticates and get the token in order to make requests to the API
+    #
+    # @return [OAuth2::AccessToken]
     def token
       OAuth2::Client.new(client_id, client_secret, site: "#{api_endpoint}/oauth/token").client_credentials.get_token
     end
 
+    # The actual client that talks to the CodesWholesale API
+    #
+    # @return [Sawyer::Agent]
     def agent
       @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
         http.headers[:content_type] = 'application/json'
@@ -30,10 +41,20 @@ module CodesWholesale
       end
     end
 
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path relative to {#api_endpoint}
+    # @param options [Hash] Query and other params for the request
+    # @return [Sawyer::Resource]
     def get(url, options = {})
       request(:get, url, options)
     end
 
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path relative to {#api_endpoint}
+    # @param options [Hash] Query and other params for the request
+    # @return [Sawyer::Resource]
     def post(url, options = {})
       request(:post, url, options)
     end

data/lib/codes_wholesale/client/accounts.rb

@@ -2,7 +2,18 @@ require 'codes_wholesale/models/account'
 
 module CodesWholesale
   class Client
+
+    # Methods for the Accounts API
+    #
+    # @see https://docs.codeswholesale.com/api-documentation
     module Accounts
+
+      # Return the current account details
+      #
+      # @return [CodesWholesale::Models::Account] Account of the authenticated user
+      # @see https://docs.codeswholesale.com/api-documentation/#api-account-details
+      # @example Get current account details
+      #   CodesWholesale.account
       def account
         CodesWholesale::Models::Account.new(get('accounts/current'))
       end

data/lib/codes_wholesale/client/orders.rb

@@ -2,7 +2,19 @@ require 'codes_wholesale/models/order'
 
 module CodesWholesale
   class Client
+
+    # Methods for the Orders API
+    #
+    # @see https://docs.codeswholesale.com/api-documentation
     module Orders
+
+      # Order a product
+      #
+      # @param product_id [String] ID of the product
+      # @return [CodesWholesale::Models::Order] Order details
+      # @see https://docs.codeswholesale.com/api-documentation/#api-single-code
+      # @example Order a product
+      #   CodesWholesale.order('6313677f-5219-47e4-a067-7401f55c5a3a')
       def order(product_id)
         CodesWholesale::Models::Order.new(post("orders?productId=#{product_id}"))
       end

data/lib/codes_wholesale/client/products.rb

@@ -2,7 +2,23 @@ require 'codes_wholesale/models/product'
 
 module CodesWholesale
   class Client
+
+    # Methods for the Products API
+    #
+    # @see https://docs.codeswholesale.com/api-documentation
     module Products
+
+      # Get all products or get a specific product
+      #
+      # @param id [String] ID of the product
+      # @return [Array<CodesWholesale::Models::Product>] A list of products
+      # @return [CodesWholesale::Models::Product] A product
+      # @see https://docs.codeswholesale.com/api-documentation/#api-products-list
+      # @see https://docs.codeswholesale.com/api-documentation/#api-id-product
+      # @example Get all products
+      #   CodesWholesale.products
+      # @example Get a specific product
+      #   CodesWholesale.products('6313677f-5219-47e4-a067-7401f55c5a3a')
       def products(id = nil)
         if id.nil?
           products = get('products')

data/lib/codes_wholesale/configurable.rb

@@ -1,9 +1,24 @@
 module CodesWholesale
+
+  # Configuration options for {Client}, defaulting to values in {Default}
   module Configurable
+    # @!attribute [w] client_id
+    # @return [String] Configure OAuth app key
+    # @!attribute [w] client_secret
+    # @return [String] Configure OAuth app secret
+    # @!attribute [w] environment
+    # @return [String] Configure API environment
+    # @!attribute user_agent
+    # @return [String] Configure User-Agent for requests
+    # @!attribute api_version
+    # @return [String] Configure API version
     attr_accessor :client_id, :client_secret, :environment,
                   :user_agent, :api_version
 
     class << self
+
+      # List of configurable keys for {CodesWholesale::Client}
+      # @return [Array] of option keys
       def keys
         @keys ||= [
           :client_id,
@@ -15,10 +30,12 @@ module CodesWholesale
       end
     end
 
+    # Set configuration options through a block
     def configure
       yield self
     end
 
+    # Reset configuration options to default values
     def reset!
       CodesWholesale::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", CodesWholesale::Default.options[key])

data/lib/codes_wholesale/default.rb

@@ -1,32 +1,54 @@
 require 'codes_wholesale/version'
 
 module CodesWholesale
+
+  # Default configuration options for {Client}
   module Default
+
+    # Default API environment
     ENVIRONMENT = 'production'.freeze
+
+    # Default API version
     API_VERSION = 'v1'.freeze
+
+    # Default User-Agent header string
     USER_AGENT = "CodesWholesale Ruby Gem #{CodesWholesale::VERSION}".freeze
 
     class << self
+
+      # Configuration options
+      # @return [Hash[
       def options
         Hash[CodesWholesale::Configurable.keys.map { |key| [key, send(key)] }]
       end
 
+      # Default API version
+      # @return [String]
       def api_version
         ENV['CODES_WHOLESALE_API_VERSION'] ||= API_VERSION
       end
 
+      # Default API environment
+      # @ return [String]
       def environment
         ENV['CODES_WHOLESALE_ENVIRONMENT'] ||= ENVIRONMENT
       end
 
+      # Default OAuth app key from ENV
+      # @return [String]
       def client_id
         ENV['CODES_WHOLESALE_CLIENT_ID']
       end
 
+
+      # Default OAuth app secret from ENV
+      # @return [String]
       def client_secret
         ENV['CODES_WHOLESALE_CLIENT_SECRET']
       end
 
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
       def user_agent
         ENV['CODES_WHOLESALE_USER_AGENT'] || USER_AGENT
       end

data/lib/codes_wholesale/version.rb

@@ -1,3 +1,3 @@
 module CodesWholesale
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codes_wholesale
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Terence Ponce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler