unleashed 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8cf451e716eaf53fdd1c508701a506625f9d10f62a26cb7298e8b32a9832dc0
-  data.tar.gz: ed27ce803188bbaf52c87161d5adff85a9706a7f96d836e688199b1e622d88b1
+  metadata.gz: 9fecd731ad21c9865bf063762b3ef5a61b36a1a05a732939aabb1bc25c3f0113
+  data.tar.gz: 168ecfdb748724ef08bdc61fda96df7db734ff51998c13571a87f72ce59de1f5
 SHA512:
-  metadata.gz: ce74137ff724c846b635cc790f0031143ceb8dbc40cccff2e2e8b5db1bbcf5ff8d6401063130022583a8e69c2feccbb6894471339e6d7857973754103c6bceb8
-  data.tar.gz: c23906fd924b35d65cca03a2df50cc88a09a8503a6708b16b379b9a238b92e88824042fa86b503c248de1005079f1ef86f03fe5de73987837bbfbfde08df26fe
+  metadata.gz: e9200bb879c2838c675315f5adbe0ceffbcfa5ff6f11a10eede2c619f0f6ef254565625363c515fa5fd2609dc5ce9085d6935dbbd5a329712303224184b564e5
+  data.tar.gz: be8b6c15381094f97e42d59894519dd3b86c4587df0eec55d3a7347362945815fa0e6c1181fede9fc19653ec60c59f7504583d47ebaa010f8ec25bf4293257e6

data/.rspec

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

data/.ruby-version

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

data/.travis.yml

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

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

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

data/LICENSE

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

data/LICENSE.txt

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

data/README.md

@@ -24,7 +24,7 @@ Before interacting with Unleashed API you need to sign up an account.
 
 See [Unleashed API Documentation](https://apidocs.unleashedsoftware.com/) for more information.
 
-### Create a Unleashed client
+### Setup environment variables
 
 The client can be configured through environment variables.
 
@@ -45,9 +45,17 @@ The following parameters are configurable through the client:
 * `:api_key` / `ENV['UNLEASHED_API_KEY']`: API KEY
 * `:client_type_header` / `ENV['UNLEASHED_CLIENT_TYPE_HEADER']`: Client Type Header to use (default: 'API-Sandbox')
 
+### Setup default Unleashed client from environment variables
+
+Add file `unleashed.rb` to `config/initializers`
+
+```ruby
+Unleashed.setup
+```
+
 ## 3. Usage
 
-### Instantiate the Unleashed client
+### Instantiate the Unleashed client manually
 
 ```ruby
 options = { api_id: ENV['UNLEASHED_API_ID'], api_key: ENV['UNLEASHED_API_KEY'] }
@@ -68,6 +76,32 @@ client.customers.all
 client.customers.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
 ```
 
+#### Get the first customer
+
+```ruby
+client.customers.first
+```
+
+#### Get the last customer
+
+```ruby
+client.customers.last
+```
+
+### Invoices
+
+#### Get all invoices
+
+```ruby
+client.invoices.all
+```
+
+#### Get an invoice
+
+```ruby
+client.invoices.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
+```
+
 ## 4. Contributing
 
   1. Fork it [https://github.com/nnhansg/unleashed-ruby](https://github.com/nnhansg/unleashed-ruby)

data/Rakefile

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

data/lib/unleashed/client.rb

@@ -2,8 +2,10 @@ require_relative 'configurable'
 require_relative 'error'
 require_relative 'models/base_model'
 require_relative 'models/customer'
+require_relative 'models/invoice'
 require_relative 'resources/base_resource'
 require_relative 'resources/customer_resource'
+require_relative 'resources/invoice_resource'
 require 'json'
 require 'faraday'
 
@@ -69,66 +71,13 @@ module Unleashed
       response
     end
 
-    # # Make a HTTP POST request
-    # #
-    # # @param url [String] The path, relative to {#api_endpoint}
-    # # @param parameters [Hash] Query params for request
-    # # @return [Faraday::Response]
-    # def post(url, parameters = {})
-    #   response = connection.post do |req|
-    #     req.url "#{api_endpoint}#{url}"
-    #     req.headers['Content-Type'] = 'application/json'
-    #     req.body = parameters.to_json
-    #   end
-    #   on_complete(response)
-    #   response
-    # end
-
-    # # Make a HTTP PATCH request
-    # #
-    # # @param url [String] The path, relative to {#api_endpoint}
-    # # @param parameters [Hash] Query params for request
-    # # @return [Faraday::Response]
-    # def patch(url, parameters = {})
-    #   response = connection.patch do |req|
-    #     req.url "#{api_endpoint}#{url}"
-    #     req.headers['Content-Type'] = 'application/json'
-    #     req.body = parameters.to_json
-    #   end
-    #   on_complete(response)
-    #   response
-    # end
-
-    # # Make a HTTP DELETE request
-    # #
-    # # @param url [String] The path, relative to {#api_endpoint}
-    # # @param parameters [Hash] Query params for request
-    # # @return [Faraday::Response]
-    # def delete(url, parameters = {})
-    #   response = connection.delete do |req|
-    #     req.url "#{api_endpoint}#{url}"
-    #     req.headers['Content-Type'] = 'application/json'
-    #     req.body = parameters.to_json
-    #   end
-    #   on_complete(response)
-    #   response
-    # end
-
-    # Show details of your Platform.
-    #
-    # @see https://reference.Unleashed.com/#show-marketplace
-    #
-    # @return [Hash]
-    def marketplace
-      JSON.parse(get('marketplace').body)['marketplaces']
-    end
-
     # Available resources for {Client}
     #
     # @return [Hash]
     def self.resources
       {
-        customers: CustomerResource
+        customers: CustomerResource,
+        invoices: InvoiceResource
       }
     end
 

data/lib/unleashed/configurable.rb

@@ -3,6 +3,7 @@ module Unleashed
   module Configurable
     attr_accessor :api_domain, :api_id, :api_key, :client_type_header, :errors_format
 
+    # Class Configurable
     class << self
       # List of configurable keys for {Unleashed::Client}.
       #

data/lib/unleashed/models/customer.rb

@@ -1,4 +1,3 @@
-
 module Unleashed
   # Manage Customers
   class Customer < BaseModel

data/lib/unleashed/models/invoice.rb

@@ -0,0 +1,6 @@
+module Unleashed
+  # Manage Invoices
+  class Invoice < BaseModel
+  end
+end
+  

data/lib/unleashed/resources/customer_resource.rb

@@ -34,5 +34,19 @@ module Unleashed
       response = JSON.parse(@client.get("Customers/#{id}").body)
       Unleashed::Customer.new(@client, response)
     end
+
+    # Get a first customer in all
+    #
+    # @return [Unleashed::Customer]
+    def first
+      all.first
+    end
+
+    # Get a last customer in all
+    #
+    # @return [Unleashed::Customer]
+    def last
+      all.last
+    end
   end
 end

data/lib/unleashed/resources/invoice_resource.rb

@@ -0,0 +1,39 @@
+module Unleashed
+  # Resource for the Invoices API
+  # The Invoices resource allows sales invoices to be listed and viewed.
+  # An individual sales invoice details can be viewed by appending its identifier 
+  # (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.
+  #
+  # @see https://apidocs.unleashedsoftware.com/Invoices
+  class InvoiceResource < BaseResource
+    def model
+      Unleashed::Invoice
+    end
+
+    # List all invoices
+    # /Invoices - also returns the first 200 invoices because page number 1 is the default.
+    #
+    # @param options [Hash] Optional options.
+    # @option options [Integer] :page_size Can ask for up to 200 invoices. default: 10
+    # @option options [Integer] :page Page index. default: 1
+    #
+    # @return [Array<Unleashed::Invoice>] List all invoices.
+    def all(options = { page: 1, page_size: 10 })
+      response = JSON.parse(@client.get('Invoices', options).body)
+      invoices = response.key?('Items') ? response['Items'] : []
+      invoices.map { |attributes| Unleashed::Invoice.new(@client, attributes) }
+    end
+
+    # Get a single invoice
+    # /Invoices/E6E8163F-6911-40e9-B740-90E5A0A3A996 - returns details of a particular invoice.
+    #
+    # @param id [String] invoice ID.
+    #
+    # @return [Unleashed::Invoice]
+    def find(id)
+      response = JSON.parse(@client.get("Invoices/#{id}").body)
+      Unleashed::Invoice.new(@client, response)
+    end
+  end
+end
+  

data/lib/unleashed/version.rb

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

data/unleashed.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleashed
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Nhan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,8 +115,10 @@ files:
 - lib/unleashed/error.rb
 - lib/unleashed/models/base_model.rb
 - lib/unleashed/models/customer.rb
+- lib/unleashed/models/invoice.rb
 - lib/unleashed/resources/base_resource.rb
 - lib/unleashed/resources/customer_resource.rb
+- lib/unleashed/resources/invoice_resource.rb
 - lib/unleashed/version.rb
 - unleashed.gemspec
 homepage: https://github.com/nnhansg/unleashed-ruby