unleashed 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c62650fc04b7e843cc1459a5cb12ca9df0297d8686a31acb79c63b2f0ba9be1
-  data.tar.gz: 3668df7548905aa45fb7437ec06af4a5a629980c1bc4a8dc1afeb8e876657698
+  metadata.gz: bf3ba61a8bff2e77aa0ace253add4da5afbda0061714a9c88845ece3ae649dd4
+  data.tar.gz: ba46eed20ad77d7b8d26f299067e54be7e374380803aaf13a84c759e6b2511e7
 SHA512:
-  metadata.gz: 830e6c1a1e00f3be6dcf86e82375acb7a6ccd3c81ec7a9f6b8ce35229dc744d7993b17d53b585c296fa3ffe8eb1f32702186bb63eb958c13108618888b37562f
-  data.tar.gz: 05efbbff8f6a7400510f2e6444c24cd8b5b62602f61c25f93440b27194ee9212322ba0a928fa990c543f7b4e66f415e3faeacfb88c58bd527dde5b40e2f432f3
+  metadata.gz: ac418597461705c6773100bba898c13f9b26736da7d6a629124d4fcbfb6c9616b3ff74c5e221f91499d467b06ef116a8e5e5d01ad966129c655f2a52450ad946
+  data.tar.gz: db6da8431dd8462425306858a923d8709304aa1abd6c7252550fb8b16ba249deb5e75d85f9f9ef7b70d34108506cd01753ff4c2ef4f935aee8d70a474af4118b

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.9] - 2019-11-29
+
+- Add `attr_reader` attributes applying for all models.
+- Update configuration of dependencies.
+- Add first, last methods for `invoice` model.
+
+## [0.1.7] - 2019-11-13
+
+- Show messages when having any error.
+
+## [0.1.6] - 2019-11-13
+
+- Add some methods to `Customer`
+- Update readme.
+
+## [0.1.5] - 2019-11-11
+
+- Some small updates.
+
 ## [0.1.4] - 2019-11-11
 
 - Add `Customer` resource

data/README.md

@@ -64,6 +64,126 @@ client = Unleashed::Client.new(options)
 
 ### Customers
 
+#### Create a new Customer
+
+```ruby
+customer = client.customers.create(
+  Guid: '59f21e05-07fe-4d9d-b460-a09db4c3caa9',
+  Addresses: [
+    {
+      AddressType: 'Shipping',
+      AddressName: 'Example Address',
+      StreetAddress: 'Example Address',
+      StreetAddress2: 'Example Address 2',
+      Suburb: 'Example Suburb',
+      City: 'Auckland',
+      Region: 'Auckland',
+      Country: 'New Zealand',
+      PostalCode: '1061',
+      IsDefault: false,
+      DeliveryInstruction: 'Have a good day'
+    }
+  ],
+  TaxCode: '',
+  TaxRate: nil,
+  CustomerCode: 'UnleashedCustomer',
+  CustomerName: 'Unleashed Customer',
+  GSTVATNumber: nil,
+  BankName: nil,
+  BankBranch: nil,
+  BankAccount: nil,
+  Website: nil,
+  PhoneNumber: nil,
+  FaxNumber: nil,
+  MobileNumber: nil,
+  DDINumber: nil,
+  TollFreeNumber: nil,
+  Email: nil,
+  EmailCC: nil,
+  Currency: {
+    CurrencyCode: 'NZD',
+    Description: 'New Zealand, Dollars',
+    Guid: 'c33e4f50-e42b-40cd-9147-4d0e4657cd4d'
+  },
+  Notes: nil,
+  Taxable: true,
+  SalesPerson: nil,
+  DiscountRate: 0.0000,
+  PrintPackingSlipInsteadOfInvoice: false,
+  PrintInvoice: false,
+  StopCredit: false,
+  Obsolete: false,
+  XeroSalesAccount: nil,
+  XeroCostOfGoodsAccount: nil,
+  SellPriceTier: '',
+  SellPriceTierReference: nil,
+  CustomerType: 'Cash',
+  PaymentTerm: '20th Month following',
+  ContactFirstName: nil,
+  ContactLastName: nil
+)
+```
+
+#### Update a Customer
+
+```ruby
+customer = client.customers.update(
+  Guid: '59f21e05-07fe-4d9d-b460-a09db4c3caa9',
+  Addresses: [
+    {
+      AddressType: 'Shipping',
+      AddressName: 'Example Address',
+      StreetAddress: 'Example Address',
+      StreetAddress2: 'Example Address 2',
+      Suburb: 'Example Suburb',
+      City: 'Auckland',
+      Region: 'Auckland',
+      Country: 'New Zealand',
+      PostalCode: '1061',
+      IsDefault: false,
+      DeliveryInstruction: 'Have a good day'
+    }
+  ],
+  TaxCode: '',
+  TaxRate: nil,
+  CustomerCode: 'UnleashedCustomer',
+  CustomerName: 'Unleashed Customer',
+  GSTVATNumber: nil,
+  BankName: nil,
+  BankBranch: nil,
+  BankAccount: nil,
+  Website: nil,
+  PhoneNumber: nil,
+  FaxNumber: nil,
+  MobileNumber: nil,
+  DDINumber: nil,
+  TollFreeNumber: nil,
+  Email: nil,
+  EmailCC: nil,
+  Currency: {
+    CurrencyCode: 'NZD',
+    Description: 'New Zealand, Dollars',
+    Guid: '6cb5d67a-1c96-4fa8-bf59-b23c2d69f22a'
+  },
+  Notes: nil,
+  Taxable: true,
+  SalesPerson: nil,
+  DiscountRate: 0.0000,
+  PrintPackingSlipInsteadOfInvoice: false,
+  PrintInvoice: false,
+  StopCredit: false,
+  Obsolete: false,
+  XeroSalesAccount: nil,
+  XeroCostOfGoodsAccount: nil,
+  SellPriceTier: '',
+  SellPriceTierReference: nil,
+  CustomerType: 'Cash',
+  PaymentTerm: '20th Month following',
+  ContactFirstName: nil,
+  ContactLastName: nil
+)
+```
+
 #### Get all customers
 
 ```ruby

data/lib/unleashed/client.rb

@@ -10,6 +10,16 @@ require 'json'
 require 'faraday'
 
 module Unleashed
+  class CustomParamsEncoder
+    def self.encode(params)
+      Faraday::NestedParamsEncoder.encode(params).gsub(/\+/, '%20')
+    end
+
+    def self.decode(query)
+      Faraday::NestedParamsEncoder.decode(query)
+    end
+  end
+
   # Client for the Unleashed API
   #
   # @see https://apidocs.unleashedsoftware.com
@@ -29,7 +39,7 @@ module Unleashed
     #
     # @return [Faraday::Connection]
     def connection
-      Faraday.new(url: @api_endpoint) do |faraday|
+      Faraday.new(url: @api_endpoint, request: { params_encoder: CustomParamsEncoder }) do |faraday|
         faraday.adapter :net_http
       end
     end
@@ -71,6 +81,30 @@ 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 = {}, headers = {}, skip_status_check = false)
+      response = connection.post do |request|
+        request.url "#{api_endpoint}#{url}"
+
+        # Set headers
+        init_default_headers(request)
+
+        # Assign more custom headers
+        headers.each do |key, value|
+          request.headers[key] = value
+        end
+
+        request.body = parameters.to_json
+      end
+
+      on_complete(response) unless skip_status_check
+      response
+    end
+
     # Available resources for {Client}
     #
     # @return [Hash]

data/lib/unleashed/error.rb

@@ -43,6 +43,7 @@ module Unleashed
         json_response = JSON.parse(@response.body)
         message = ''
         message << json_response['description'] if json_response.key?('description')
+        message << json_response['Description'] if json_response.key?('Description')
 
         if json_response.key?('errors')
           message << json_response['errors'].map { |attribute, content| "#{attribute}: #{content}" }.join(', ')

data/lib/unleashed/models/currency.rb

@@ -0,0 +1,5 @@
+module Unleashed
+  # Manage Currencies
+  class Currency < BaseModel
+  end
+end

data/lib/unleashed/resources/currency_resource.rb

@@ -0,0 +1,38 @@
+module Unleashed
+  # Resource for the Currencies API
+  # The Currencies resource allows Currencies to be listed, viewed.
+  # @see https://apidocs.unleashedsoftware.com/Sandbox
+  class CurrencyResource < BaseResource
+    def model
+      Unleashed::Currency
+    end
+
+    # List all currencies
+    # /Currencies - also returns the first 200 currencies because page number 1 is the default.
+    #
+    # @param options [Hash] Optional options.
+    # @option options [Integer] :page_size Can ask for up to 200 currencies. default: 10
+    # @option options [Integer] :page Page index. default: 1
+    #
+    # @return [Array<Unleashed::Currency>] List all currencies.
+    def all(options = { page: 1, page_size: 10 })
+      response = JSON.parse(@client.get('Currencies', options).body)
+      currencies = response.key?('Items') ? response['Items'] : []
+      currencies.map { |attributes| Unleashed::Currency.new(@client, attributes) }
+    end
+
+    # Get a first currency in all
+    #
+    # @return [Unleashed::Currency]
+    def first
+      all.first
+    end
+
+    # Get a last currency in all
+    #
+    # @return [Unleashed::Currency]
+    def last
+      all.last
+    end
+  end
+end

data/lib/unleashed/resources/customer_resource.rb

@@ -48,5 +48,16 @@ module Unleashed
     def last
       all.last
     end
+
+    # Create a new customer for a marketplace
+    #
+    # @param attributes [Hash] Customer's attributes.
+    #
+    # @return [Unleashed::Customer]
+    def create(attributes)
+      id = attributes[:Guid].present? ? attributes[:Guid] : ''
+      response = JSON.parse(@client.post("Customers/#{id}", attributes).body)
+      Unleashed::Customer.new(@client, response)
+    end
   end
 end

data/lib/unleashed/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleashed
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Nhan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,9 +114,11 @@ files:
 - lib/unleashed/default.rb
 - lib/unleashed/error.rb
 - lib/unleashed/models/base_model.rb
+- lib/unleashed/models/currency.rb
 - lib/unleashed/models/customer.rb
 - lib/unleashed/models/invoice.rb
 - lib/unleashed/resources/base_resource.rb
+- lib/unleashed/resources/currency_resource.rb
 - lib/unleashed/resources/customer_resource.rb
 - lib/unleashed/resources/invoice_resource.rb
 - lib/unleashed/version.rb