snap-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a50261392621d61f3d3f094c1a5692139021c057d2cab037212a856ab7a76a7d
-  data.tar.gz: dc538907ae6ad79ed9682f871046329b3943e7d628294c53895352e9ab011e5f
+  metadata.gz: 8893c6ba1b64a97074146fae0aba8fe8f3bf1be9e52b19ee9bcd99aec198ff3b
+  data.tar.gz: a50a60eab5350b42717efab3e0fa3dfd749494d9b1b93302693550378271a40a
 SHA512:
-  metadata.gz: 38ff79ecb25b6583e2713de2d3181fb3e92e56c4f04111526158684f98fd42c24346444df5bfe4fa3ca4dc6c82d7ec1730bcb016001ee1c57f4c33da0df31a40
-  data.tar.gz: ca431ca5f8f145d58dd1235b1969a8d3fecf51bb17cd2e273fc5281bbb6473c21df2f635c3088545dabee0b2d4306888751a56e23a080ad428b1bdf3262577c0
+  metadata.gz: 7fd7dde555c9d92cf649ea79e5b4278142a51295c6a502d1828d3a7cd2ce934cc122f29eac7bfd08c00031dd47036b144fb0142201e2977aa68b3dd91adc064c
+  data.tar.gz: f733aeb8f05509b02387bb06a14ad6b2394186c7e5dc2134a2b31920f9593ff77e9afca419aa9dde48d0f79a5b57c21d0ffb1cdc62d52ccc2f42425da3416549

data/History.md

@@ -0,0 +1,39 @@
+
+0.1.1 / 2018-09-16
+==================
+
+  * Add Shipments#destroy
+  * Add Shipments#create
+  * Add image to readme
+  * Add basic usage instructions
+  * Update Gem install instructions
+  * Add Snap shipment model
+  * Add gem version badge
+  * Add CodeClimate badges
+  * Update rake requirement from ~> 10.0 to ~> 12.3
+  * Add Changelog
+
+0.1.0 / 2018-09-15
+==================
+
+  * Update name of gem to avoid conflict
+  * Add Shipments#find
+  * Add VCR
+  * Add a base client
+  * Add HTTParty
+  * Add initializer for local dev
+  * Make binding.pry available in test
+  * Add sample .env and fix setup bug
+  * Add dotenv
+  * Add SimpleCov
+  * Add configuration object
+  * Lint all the things
+  * Add rubocop
+  * Add pry
+  * Remove default failing spec
+  * Don't commit Gemfile.lock
+  * Update gem description
+  * Merge branch 'master' of github.com:MeUndies/snap
+  * Update Travis CI yaml
+  * Initial commit
+  * Initial commit

data/README.md

@@ -1,32 +1,44 @@
+![Bag Logo](https://user-images.githubusercontent.com/1624718/45594013-e7593580-b947-11e8-911c-282ae1d19654.png)
+
 # Snap
 
+[![Gem Version](https://badge.fury.io/rb/snap-api.svg)](https://badge.fury.io/rb/snap-api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/818c40e75cd06a101b79/maintainability)](https://codeclimate.com/github/MeUndies/snap/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/818c40e75cd06a101b79/test_coverage)](https://codeclimate.com/github/MeUndies/snap/test_coverage)
+
 A ruby gem to interact with the Snapfulfil API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby gem 'snap' ```
+```ruby
+gem 'snap-api', require: 'snap'
+```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install snap
-
 ```ruby
+
 Snap.configure do |config|
   config.endpoint = 'https://your-api-endpoint'
   config.username = 'Fred'
   config.password = 'Rogers'
 end
+
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+
+Snap::Api::Shipments.find(id: 'your-shipment-id')
+
+```
+
+
 
 ## Development
 

data/lib/snap/api/shipments.rb

@@ -8,6 +8,15 @@ module Snap
       def self.find(id:)
         client.get("/shipments/#{id}")
       end
+
+      def self.destroy(id:)
+        client.delete("/shipments/#{id}")
+      end
+
+      def self.create(options)
+        shipment = Snap::Shipment.new(options)
+        client.post('/shipments', body: shipment)
+      end
     end
   end
 end

data/lib/snap/models/shipment.rb

@@ -0,0 +1,94 @@
+module Snap
+  module Models
+    # A representation of a Snap Shipment object.
+    class Shipment < Hashie::Dash
+      include Hashie::Extensions::IndifferentAccess
+
+      property :ShipmentId, required: true
+      property :BizId
+      property :BizSalesOrder
+      property :Status
+      property :OrderType
+      property :OrderClass
+      property :CustomerId, required: true
+      property :BizCustomerId
+      property :CustomerGroup
+      property :CustomerName
+      property :ShippingAddressId
+      property :InvoiceAddressId
+      property :Site
+      property :Warehouse
+      property :OwnerId
+      property :StockStatus
+      property :SalesOrder
+      property :Prime
+      property :PriorityAllocation
+      property :PriorityDespatch
+      property :CustomerRef
+      property :ConsigmentId
+      property :PickGroupId
+      property :ASNNumber
+      property :DNoteNumber
+      property :InvoiceNumber
+      property :ManifestNumber
+      property :POD
+      property :ShippingMethod
+      property :Region
+      property :CarrierId
+      property :CarrierTrackingNumber
+      property :Route
+      property :LoadId
+      property :LoadSequence
+      property :PackStation
+      property :ShippingLane
+      property :ReturnReason
+      property :QC
+      property :Lines
+      property :LineQty
+      property :StUQty
+      property :Volume
+      property :Weight
+      property :ActualWeight
+      property :TaskCountNew
+      property :TaskCountCurrent
+      property :TaskCountActioned
+      property :TimeToPick
+      property :TimeToPack
+      property :TimeToCheck
+      property :TimeToLoad
+      property :TimeOther
+      property :TimeToDeliver
+      property :InvoiceInd
+      property :Currency
+      property :LineValue
+      property :Discount
+      property :Packing
+      property :Freight
+      property :Insurance
+      property :Charges
+      property :Allowances
+      property :Tax
+      property :InvoiceValue
+      property :ShortageCode
+      property :Variance
+      property :CutOffInd
+      property :Supervisor
+      property :Reason
+      property :DateCreated
+      property :DateSuspended
+      property :DateClosed
+      property :DateDueOut, required: true
+      property :DateShipment
+      property :DateDelivery
+      property :DateInvoice
+      property :ASNInd
+      property :OverdueInd
+      property :Stage
+      property :MaintInd
+      property :ShipmentLines
+      property :ShipAddress
+      property :ShipContacts
+      property :ShipmentDespatch
+    end
+  end
+end

data/lib/snap/version.rb

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

data/lib/snap.rb

@@ -1,12 +1,16 @@
+require 'hashie'
 require 'httparty'
 
 require 'snap/version'
 require 'snap/client'
 
 require 'snap/api/shipments'
+require 'snap/models/shipment'
 
 # Top level module for the Snap gem.
 module Snap
+  include Models
+
   class << self
     attr_accessor :config
   end

data/snap.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'hashie', '~> 3.5'
   spec.add_dependency 'httparty', '~> 0.16'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'dotenv', '~> 2.5'
   spec.add_development_dependency 'pry', '~> 0.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.59'
   spec.add_development_dependency 'simplecov', '~> 0.16'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snap-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Hood
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2018-09-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +177,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- History.md
 - LICENSE
 - README.md
 - Rakefile
@@ -172,6 +187,7 @@ files:
 - lib/snap.rb
 - lib/snap/api/shipments.rb
 - lib/snap/client.rb
+- lib/snap/models/shipment.rb
 - lib/snap/version.rb
 - snap.gemspec
 homepage: https://github.com/MeUndies/snap