veeqo_api_ruby 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ec25fe807f27f4e40bb903d914757c17a755285
-  data.tar.gz: 2869d1d72094c5534d62e9d9265f32359d301d3b
+  metadata.gz: 5cf3b67027ebfec13af0469c401ab940ec7987aa
+  data.tar.gz: 486445cebc519706afe0264b21740f55805860c5
 SHA512:
-  metadata.gz: 0e343ad817ba2eb30e311290b090576ad10fb795f07f09ea283ed74ea07620dbe946570cb6a2b6c532a3e3cdb362e1b1283dcffd5260ba06809cbf6d04620711
-  data.tar.gz: 2920713e83656d60e2ea665aead6efc33a697c493cfb18a06fee9bfd07c96cf5daed871594f2072429186d964100bece063386b3c70cdc0c166891fc769aed09
+  metadata.gz: f4003cea81aa122e13e4677ced2d225b99a7b2ea60ed3def4201453e0913196fe58089ffd91ee177b052d0211832dd7d27b7ce2e810ca7a47029d1b8e48b7b1a
+  data.tar.gz: 9d84d4760e10b0a27f5565f903bed70170505c21c6d614d7155ced2f39302080f63d1722aaa7bd94b3f42ba9bee4646f301089473ae3f180c01726757bf865c5

data/lib/veeqo.rb

@@ -1,4 +1,5 @@
 require 'hashie'
+require 'oj'
 require 'faraday_middleware'
 require 'veeqo/version'
 require 'veeqo/config'

data/lib/veeqo/exception.rb

@@ -44,7 +44,7 @@ module Veeqo
       response_headers = {}
       unless env.body.empty?
         response_headers = begin
-          JSON.parse(env.body, symbolize_names: true)
+          Oj.load(env.body, symbol_keys: true)
         rescue
           {}
         end

data/lib/veeqo/middleware/auth.rb

@@ -8,6 +8,7 @@ module Veeqo
 
       def call(env)
         env[:request_headers]['x-api-key'] = @options[:api_key]
+        env[:request_headers]['x-api-request'] = 'true'
         @app.call env
       end
     end

data/lib/veeqo/request.rb

@@ -50,7 +50,8 @@ module Veeqo
 
       def delete(path, params = {})
         response = raw_request(:delete, path, params)
-        response.body
+        return response.body if response.body.empty?
+        build_response_object response
       end
 
       def post(path, params = {})
@@ -63,6 +64,11 @@ module Veeqo
         build_response_object response
       end
 
+      def quantity(path, params = {})
+        response = raw_request(:get, path, params)
+        response.headers['X-Total-Count'].to_i
+      end
+
       def raw_request(method, path, params = {})
         client = params.delete(:connection) || Veeqo.api
         client.send(method, path.to_s, params)
@@ -81,7 +87,7 @@ module Veeqo
 
       def parse(json)
         return [] if json.empty?
-        JSON.parse(json, symbolize_names: true)
+        Oj.load(json, symbol_keys: true)
       end
     end
   end

data/lib/veeqo/resource_actions.rb

@@ -4,19 +4,21 @@ module Veeqo
 
     def initialize(options = {})
       @options = options
-      tap do |mod|
-        mod.define_singleton_method :_options do
-          mod.options
-        end
+      define_singleton_method :_options do
+        options
       end
     end
 
     def included(base)
       base.send(:include, Request.new(options[:uri]))
       base.extend(ClassMethods)
-      options[:disable_methods] ||= []
-      methods = ClassMethods.public_instance_methods & options[:disable_methods]
-      methods.each { |name| base.send(:remove_method, name) }
+      options[:disable] ||= []
+      methods = ClassMethods.public_instance_methods & options[:disable]
+      class << base
+        self
+      end.class_eval do
+        methods.each { |filtered_name| undef_method filtered_name }
+      end
     end
 
     module ClassMethods
@@ -46,6 +48,10 @@ module Veeqo
       def destroy_all(params = {})
         delete path.build, params
       end
+
+      def count(params = {})
+        quantity path.build, params
+      end
     end
   end
 end

data/lib/veeqo/resources/allocation.rb

@@ -0,0 +1,65 @@
+# Allocations
+# Resources related to the allocations in the API.
+# http://docs.veeqo.apiary.io/#reference/allocations/allocation-collection/create-a-new-allocation
+
+module Veeqo
+  class Allocation < Resource
+    include Veeqo::SubresourceActions.new(uri: 'orders/%d/allocations/%d', disable: %i[destroy_all all find])
+
+    property :id
+    property :additional_order_level_taxless_discount
+    property :allocated_completely
+    property :allocations
+    property :allocated_by_id
+    property :buyer_user_id
+    property :cancel_reason
+    property :cancelled_at
+    property :cancelled_by
+    property :channel
+    property :created_at
+    property :created_by
+    property :customer
+    property :customer_note
+    property :customer_viewable_notes
+    property :deliver_to
+    property :delivery_cost
+    property :delivery_method
+    property :due_date
+    property :employee_notes
+    property :fulfilled_by_amazon
+    property :fulfillment_channel_order
+    property :international
+    property :is_amazon_premium_order
+    property :is_amazon_prime
+    property :line_items
+    property :matched_parcel_properties_criteria
+    property :notes
+    property :number
+    property :order_id
+    property :packed_completely
+    property :payment
+    property :picked_completely
+    property :receipt_printed
+    property :recommended_shipping_options
+    property :refund_amount
+    property :restock_shipped_items
+    property :returns
+    property :send_notification_email
+    property :send_refund_email
+    property :shipment
+    property :shipped_at
+    property :status
+    property :subtotal_price
+    property :tags
+    property :till_id
+    property :total_discounts
+    property :total_fees
+    property :total_price
+    property :total_tax
+    property :total_weight
+    property :updated_at
+    property :updated_by
+    property :weight_unit
+    property :warehouse
+  end
+end

data/lib/veeqo/resources/channel.rb

@@ -1,6 +1,6 @@
 # Channels
 # Resources related to the channels in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/channels
+# http://docs.veeqo.apiary.io/#reference/stores/store-collection/list-all-stores
 
 module Veeqo
   class Channel < Resource

data/lib/veeqo/resources/company.rb

@@ -1,6 +1,6 @@
 # Company
 # Metadata that describes the Company.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/company
+# http://docs.veeqo.apiary.io/#reference/company/company/view-company-detail
 
 module Veeqo
   class Company < Resource

data/lib/veeqo/resources/customer.rb

@@ -1,10 +1,10 @@
 # customers
 # Resources related to the customers in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/customers
+# http://docs.veeqo.apiary.io/#reference/customers/customer-collection/list-all-customers
 
 module Veeqo
   class Customer < Resource
-    include Veeqo::ResourceActions.new(uri: 'customers/%d', disable: [:destroy, :destroy_all])
+    include Veeqo::ResourceActions.new(uri: 'customers/%d', disable: %i[destroy destroy_all])
 
     property :id
     property :email

data/lib/veeqo/resources/delivery_method.rb

@@ -1,10 +1,10 @@
 # DeliveryMethods
 # Resources related to the DeliveryMethods in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/delivery_methods
+# http://docs.veeqo.apiary.io/#reference/delivery-methods/delivery-methods-collection/list-all-delivery-methods
 
 module Veeqo
   class DeliveryMethod < Resource
-    include Veeqo::ResourceActions.new(uri: 'delivery_methods/%d', disable: [:destroy_all])
+    include Veeqo::ResourceActions.new(uri: 'delivery_methods/%d', disable: %i[destroy_all count])
 
     property :id
     property :cost

data/lib/veeqo/resources/order.rb

@@ -1,10 +1,10 @@
 # Orders
 # Resources related to the orders in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/orders
+# http://docs.veeqo.apiary.io/#reference/orders/order-collection
 
 module Veeqo
   class Order < Resource
-    include Veeqo::ResourceActions.new(uri: 'orders/%d', disable: [:destroy, :destroy_all])
+    include Veeqo::ResourceActions.new(uri: 'orders/%d', disable: %i[destroy destroy_all])
 
     property :id
     property :allocated_completely
@@ -48,11 +48,9 @@ module Veeqo
     property :updated_at
     property :updated_by
 
-    def self.destroy(resource_id, params = {})
-      raise ArgumentError if resource_id.nil?
-      delete path.build(resource_id), params
-    rescue Veeqo::NotFound
-      nil
+    def self.bulk_tagging(resource_ids, tag_ids, params = {})
+      raise ArgumentError if resource_ids.empty? || tag_ids.empty?
+      post 'https://app.veeqo.com/bulk_tagging', { order_ids: [*resource_ids], tag_ids: [*tag_ids] }.merge(params)
     end
   end
 end

data/lib/veeqo/resources/product.rb

@@ -1,6 +1,6 @@
 # Products
 # Resources related to the products in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/products
+# http://docs.veeqo.apiary.io/#reference/products/product-collection/list-all-products
 
 module Veeqo
   class Product < Resource

data/lib/veeqo/resources/purchase_order.rb

@@ -1,10 +1,10 @@
 # PurchaseOrder
 # Resources related to the purchase order in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/purchase_orders
+# http://docs.veeqo.apiary.io/#reference/purchase-orders/purchase-order-collection/list-all-purchase-orders
 
 module Veeqo
   class PurchaseOrder < Resource
-    include Veeqo::ResourceActions.new(uri: 'purchase_orders/%d', disable: [:update, :destroy, :destroy_all])
+    include Veeqo::ResourceActions.new(uri: 'purchase_orders/%d', disable: %i[update destroy destroy_all])
 
     property :id
     property :number
@@ -33,7 +33,7 @@ module Veeqo
 
     def self.create(params = {})
       post path.build, params
-    rescue JSON::ParserError
+    rescue Oj::ParseError
       nil
     end
   end

data/lib/veeqo/resources/shipment.rb

@@ -0,0 +1,21 @@
+# Shipments
+# Resources related to the shipments in the API.
+# http://docs.veeqo.apiary.io/#reference/shipments/shipment-collection/create-a-shipment
+
+module Veeqo
+  class Shipment < Resource
+    include Veeqo::ResourceActions.new(uri: 'shipments/%d', disable: %i[find all count destroy_all])
+
+    property :allocation_id
+    property :carrier
+    property :carrier_id
+    property :created_at
+    property :id
+    property :notify_customer
+    property :order_id
+    property :shipped_by_id
+    property :tracking_number
+    property :update_remote_order
+    property :weight
+  end
+end

data/lib/veeqo/resources/stock_entry.rb

@@ -0,0 +1,22 @@
+# Stock Entries
+# Resources related to the stock entries in the API.
+# http://docs.veeqo.apiary.io/#reference/stock-entries/stock-entry
+
+module Veeqo
+  class StockEntry < Resource
+    include Veeqo::SubresourceActions.new(uri: 'sellables/%d/warehouses/%d/stock_entry', disable: %i[destroy destroy_all all find create])
+    property :allocated_stock_level
+    property :available_stock_level
+    property :id
+    property :incoming_stock_level
+    property :infinite
+    property :location
+    property :physical_stock_level
+    property :sellable_id
+    property :sellable_on_hand_value
+    property :stock_running_low
+    property :updated_at
+    property :warehouse
+    property :warehouse_id
+  end
+end

data/lib/veeqo/resources/supplier.rb

@@ -1,10 +1,10 @@
-# customers
-# Resources related to the customers in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/customers
+# Suppliers
+# Resources related to the suppliers in the API.
+# http://docs.veeqo.apiary.io/#reference/suppliers/supplier-collection
 
 module Veeqo
   class Supplier < Resource
-    include Veeqo::ResourceActions.new(uri: 'suppliers/%d', disable: [:find, :create, :destroy, :destroy_all])
+    include Veeqo::ResourceActions.new(uri: 'suppliers/%d', disable: %i[find create destroy destroy_all])
 
     property :id
     property :name

data/lib/veeqo/resources/tag.rb

@@ -0,0 +1,14 @@
+# Tags
+# Resources related to the tags in the API.
+# http://docs.veeqo.apiary.io/#reference/tags/tag-collection
+
+module Veeqo
+  class Tag < Resource
+    include Veeqo::ResourceActions.new uri: 'tags/%d', disable: %i[destroy_all count]
+    property :colour
+    property :company_id
+    property :id
+    property :name
+    property :taggings_count
+  end
+end

data/lib/veeqo/resources/warehouse.rb

@@ -1,10 +1,10 @@
 # Warehouses
 # Resources related to the Warehouses in the API.
-# https://developers.veeqo.com/docs/versions/1-0-0-beta/resources/warehouses
+# http://docs.veeqo.apiary.io/#reference/warehouses/warehouse-collection
 
 module Veeqo
   class Warehouse < Resource
-    include Veeqo::ResourceActions.new(uri: 'warehouses/%d', disable: [:create, :update, :destroy, :destroy_all])
+    include Veeqo::ResourceActions.new(uri: 'warehouses/%d', disable: %i[create update destroy destroy_all])
 
     property :id
     property :address_line_1

data/lib/veeqo/subresource_actions.rb

@@ -1,5 +1,7 @@
 module Veeqo
   class SubresourceActions < ResourceActions
+    attr_reader :options
+
     def included(base)
       base.send(:include, Request.new(options[:uri]))
       base.extend(ClassMethods)

data/lib/veeqo/version.rb

@@ -1,3 +1,3 @@
 module Veeqo
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veeqo_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Yurkiv Misha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +152,7 @@ files:
 - lib/veeqo/middleware/http_exception.rb
 - lib/veeqo/request.rb
 - lib/veeqo/resource_actions.rb
+- lib/veeqo/resources/allocation.rb
 - lib/veeqo/resources/channel.rb
 - lib/veeqo/resources/company.rb
 - lib/veeqo/resources/customer.rb
@@ -146,7 +161,10 @@ files:
 - lib/veeqo/resources/product.rb
 - lib/veeqo/resources/purchase_order.rb
 - lib/veeqo/resources/resource.rb
+- lib/veeqo/resources/shipment.rb
+- lib/veeqo/resources/stock_entry.rb
 - lib/veeqo/resources/supplier.rb
+- lib/veeqo/resources/tag.rb
 - lib/veeqo/resources/warehouse.rb
 - lib/veeqo/subresource_actions.rb
 - lib/veeqo/version.rb