snap-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8893c6ba1b64a97074146fae0aba8fe8f3bf1be9e52b19ee9bcd99aec198ff3b
-  data.tar.gz: a50a60eab5350b42717efab3e0fa3dfd749494d9b1b93302693550378271a40a
+  metadata.gz: 36cecbcd40e05247522d1c72c79ae4f3efebbd53b59d43ff4075bb8dfe618ae9
+  data.tar.gz: f7b38ee2036e287667c2511bfceb112bc153f8917cff206601e19d37f849dfc2
 SHA512:
-  metadata.gz: 7fd7dde555c9d92cf649ea79e5b4278142a51295c6a502d1828d3a7cd2ce934cc122f29eac7bfd08c00031dd47036b144fb0142201e2977aa68b3dd91adc064c
-  data.tar.gz: f733aeb8f05509b02387bb06a14ad6b2394186c7e5dc2134a2b31920f9593ff77e9afca419aa9dde48d0f79a5b57c21d0ffb1cdc62d52ccc2f42425da3416549
+  metadata.gz: 28c1df861559b42870d2550a35580fa51639a63d476cef6a527a44f882613805cbc03f7efde68a1e898b04ebf3649c950aaa01e8565b9fc9ff707469776318bc
+  data.tar.gz: 53a198dc56fe9131bdddf27c12babfcb0fd2171727ad978800559944354b78e5775930a2f2be031ea7d92283730ce3004c470196b2fe58b046581c0ff63c574d

data/History.md

@@ -1,4 +1,12 @@
 
+0.1.2 / 2018-09-16
+==================
+
+  * Add ShipmentStatus
+  * Wrap HTTParty response
+  * Add ActiveModel validations
+  * Add ShipmentLine nested model
+
 0.1.1 / 2018-09-16
 ==================
 

data/lib/snap/api/shipment_status.rb

@@ -0,0 +1,18 @@
+module Snap
+  module Api
+    # Interact with Snapfulfil's shipment status endpoint.
+    class ShipmentStatus
+      include ::HTTParty
+      extend Client
+
+      def self.update(options)
+        shipment_status = Snap::ShipmentStatus.new(options)
+        client.put("/shipmentstatus/#{shipment_status.ShipmentId}", body: shipment_status)
+      end
+
+      def self.model
+        Snap::ShipmentStatus
+      end
+    end
+  end
+end

data/lib/snap/api/shipments.rb

@@ -17,6 +17,10 @@ module Snap
         shipment = Snap::Shipment.new(options)
         client.post('/shipments', body: shipment)
       end
+
+      def self.model
+        Snap::Shipment
+      end
     end
   end
 end

data/lib/snap/client.rb

@@ -8,5 +8,33 @@ module Snap
       basic_auth(Snap.config.username, Snap.config.password)
       self
     end
+
+    def get(*args, &block)
+      wrap_response do
+        super(*args, &block)
+      end
+    end
+
+    def post(*args, &block)
+      wrap_response do
+        super(*args, &block)
+      end
+    end
+
+    def delete(*args, &block)
+      wrap_response do
+        super(*args, &block)
+      end
+    end
+
+    def put(*args, &block)
+      wrap_response do
+        super(*args, &block)
+      end
+    end
+
+    def wrap_response
+      Snap::Response.new(yield, model)
+    end
   end
 end

data/lib/snap/models/shipment.rb

@@ -3,6 +3,13 @@ module Snap
     # A representation of a Snap Shipment object.
     class Shipment < Hashie::Dash
       include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::Dash::Coercion
+      include ActiveModel::Validations
+
+      def initialize(*args)
+        super(*args)
+        validate!
+      end
 
       property :ShipmentId, required: true
       property :BizId
@@ -85,10 +92,12 @@ module Snap
       property :OverdueInd
       property :Stage
       property :MaintInd
-      property :ShipmentLines
+      property :ShipmentLines, coerce: Array[Models::ShipmentLine]
       property :ShipAddress
       property :ShipContacts
       property :ShipmentDespatch
+
+      validates :CustomerName, length: { maximum: 50 }
     end
   end
 end

data/lib/snap/models/shipment_line.rb

@@ -0,0 +1,45 @@
+module Snap
+  module Models
+    # A representation of a single ShipmentLine.
+    class ShipmentLine < Hashie::Dash
+      include Hashie::Extensions::IndifferentAccess
+
+      property :ShipmentId, required: true
+      property :Line
+      property :Level
+      property :SKUId, required: true
+      property :BizSKU
+      property :LineOwner
+      property :LineStockStatus
+      property :QtyOrdered, required: true
+      property :QtyRequired, required: true
+      property :QtyAllocated
+      property :QtyTasked
+      property :UnitOfMeasure, required: true
+      property :QtyPicked
+      property :QtyShipped
+      property :QtyDelivered
+      property :QtyDueOut
+      property :Price, required: true
+      property :Discount
+      property :TaxRate
+      property :SOLineId
+      property :ReturnReason
+      property :QC
+      property :Shortage
+      property :Variance
+      property :BOInd
+      property :ConsignmentId
+      property :PickGroupId
+      property :SiteId
+      property :Warehouse
+      property :BizId
+      property :OwnerId
+      property :StockStatus
+      property :DateShipment
+      property :AttachmentInd
+      property :SpecialConditionInd
+      property :Stage
+    end
+  end
+end

data/lib/snap/models/shipment_status.rb

@@ -0,0 +1,12 @@
+module Snap
+  module Models
+    # A representation of a Shipment Status.
+    class ShipmentStatus < Hashie::Dash
+      include Hashie::Extensions::IndifferentAccess
+
+      property :ShipmentId, required: true
+      property :Status, required: true
+      property :Stage
+    end
+  end
+end

data/lib/snap/response.rb

@@ -0,0 +1,16 @@
+require 'delegate'
+
+module Snap
+  # Wraps HTTParty response so we can provide some helpful methods.
+  class Response < SimpleDelegator
+    def initialize(response, model)
+      @model = model
+      super(response)
+    end
+    attr_reader :model
+
+    def hydrate
+      model.new(to_hash)
+    end
+  end
+end

data/lib/snap/version.rb

@@ -1,3 +1,3 @@
 module Snap
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/snap.rb

@@ -1,10 +1,16 @@
+require 'active_model'
 require 'hashie'
 require 'httparty'
 
 require 'snap/version'
 require 'snap/client'
+require 'snap/response'
 
+require 'snap/api/shipment_status'
 require 'snap/api/shipments'
+
+require 'snap/models/shipment_status'
+require 'snap/models/shipment_line'
 require 'snap/models/shipment'
 
 # Top level module for the Snap gem.

data/snap.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activemodel', '~> 5.1'
   spec.add_dependency 'hashie', '~> 3.5'
   spec.add_dependency 'httparty', '~> 0.16'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: snap-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Hood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -185,9 +199,13 @@ files:
 - bin/setup
 - config/initializers/snap.rb
 - lib/snap.rb
+- lib/snap/api/shipment_status.rb
 - lib/snap/api/shipments.rb
 - lib/snap/client.rb
 - lib/snap/models/shipment.rb
+- lib/snap/models/shipment_line.rb
+- lib/snap/models/shipment_status.rb
+- lib/snap/response.rb
 - lib/snap/version.rb
 - snap.gemspec
 homepage: https://github.com/MeUndies/snap