finale 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7dccf6985425bb97ece7b4ea3588cd11097bb0a
-  data.tar.gz: 79773b5bf989138bdc5aa863e735d441eec4eb4c
+  metadata.gz: bdd6fa1a37947ed35b33546ae027df06a1e93325
+  data.tar.gz: f5a6e98f7c6563523dd70c9c9a4d8dfdea9a9f10
 SHA512:
-  metadata.gz: ec43e039350308485a2e91a8e15221687a92167e3c34835cbe95caebfc84cfd74994731d8a539b8727e5be82894d159371d2279dd618f1da4d610b3ec25edddb
-  data.tar.gz: b861daea16936cf30fbc0fb08c69f817beeb182d37c4f9f73ee938497803bb1211d04719db363d1c77b61c401ca19508407402d59fbd50c8f6ae30fe1d4f6670
+  metadata.gz: c0b76ec8390220b7d31ccfaf7124999399751d0b8265c96d5c4700b859ab351c8029613e2920d978e47665814cf1193e79af9e0edd422c34d765cef381970733
+  data.tar.gz: c040d45991d17d31e146e0840310fa53d30425b79073ac5a64a7d1290281e4d50b9147f2b2d26b185f3c0d8d555ea03765282745b219bd9a2cdd87e595828ca8

data/.gitignore

@@ -6,6 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
+*.swp
+*.swo
+*.swn
 
 # rspec failure tracking
 .rspec_status

data/finale.gemspec

@@ -32,7 +32,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rest-client", "~> 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "webmock", "~> 3.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry-byebug', '~> 3'
+  spec.add_development_dependency "factory_bot", "~> 4.10"
 end

data/lib/finale.rb

@@ -1,5 +1,76 @@
+require "rest-client"
+
+require "finale/version"
+require "finale/errors"
+require "finale/order"
 require "finale/version"
 
 module Finale
-  # Your code goes here...
+  class Client
+    MAX_REQUESTS = 100 # Finale API Usage: 'https://support.finaleinventory.com/hc/en-us/articles/115007830648-Getting-Started'
+    BASE_URL     = 'https://app.finaleinventory.com'
+
+    def initialize(company)
+      @cookies       = nil
+      @request_count = 0
+      @company       = company
+      @login_url     = construct_url(:auth)
+      @order_url     = construct_url(:order)
+      @shipment_url  = construct_url(:shipment)
+    end
+
+    def login(username: nil, password: nil)
+      payload = {
+        username: username || ENV['FINALE_USERNAME'],
+        password: password || ENV['FINALE_PASSWORD']
+      }
+
+      request(verb: :LOGIN, payload: payload)
+    end
+
+    def get_order_ids
+      body      = request(verb: :GET, url: @order_url)
+      order_ids = body[:orderId]
+      order_ids.map(&:to_i).sort.uniq
+    end
+
+    def get_order(id)
+      response = request(verb: :GET, url: "#{@order_url}/#{id}")
+      Order.new(response)
+    end
+
+    def get_shipments(order)
+      order.shipment_urls.map do |suffix_url|
+        url      = "#{BASE_URL}#{suffix_url}"
+        response = request(verb: :GET, url: url)
+        Shipment.new(response)
+      end
+    end
+
+    private
+
+    def construct_url(resource)
+      "#{BASE_URL}/#{@company}/api/#{resource}"
+    end
+
+    def request(verb: nil, url: nil, payload: nil)
+      raise MaxRequests.new(MAX_REQUESTS) if @request_count >= MAX_REQUESTS
+      raise NotLoggedIn.new(verb: verb, url: url) unless verb == :LOGIN || !@cookies.nil?
+
+      case verb
+      when :LOGIN
+        response = RestClient.post(@login_url, payload)
+        @cookies = response.cookies
+      when :GET
+        response = RestClient.get(url, cookies: @cookies)
+      when :POST
+        response = RestClient.post(url, cookies: @cookies)
+      end
+
+      @request_count += 1
+      body = JSON.parse(response.body, symbolize_names: true)
+      body
+    end
+  end
 end
+

data/lib/finale/errors.rb

@@ -0,0 +1,16 @@
+module Finale
+  class NotLoggedIn < StandardError
+    def initialize(verb: nil, url: nil)
+      message = "Request to (#{verb}) #{url} can't be made. You are not logged in."
+      super(message)
+    end
+  end
+
+  class MaxRequests < StandardError
+    def initialize(max_requests)
+      message = "Finale API request max reached: '#{max_requests}'"
+      super(message)
+    end
+  end
+end
+

data/lib/finale/order.rb

@@ -0,0 +1,12 @@
+module Finale
+  class Order
+    attr_reader :id, :shipment_urls, :source
+
+    def initialize(order_response)
+      @id            = order_response[:orderId]&.to_i
+      @shipment_urls = order_response[:shipmentUrlList]
+      @source        = order_response[:saleSourceId]
+    end
+  end
+end
+

data/lib/finale/shipment.rb

@@ -0,0 +1,11 @@
+module Finale
+  class Shipment
+    attr_reader :id
+
+    def initialize(shipment_response)
+      @id        = shipment_response[:shipmentId]&.to_i
+      @item_list = shipment_response[:shipmentItemList]
+    end
+  end
+end
+

data/lib/finale/version.rb

@@ -1,3 +1,3 @@
 module Finale
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: finale
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - popp0102
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
 description: A client to interact with the Finale Inventory System.
 email:
 - popp0102@getnotion.com
@@ -71,6 +127,9 @@ files:
 - bin/setup
 - finale.gemspec
 - lib/finale.rb
+- lib/finale/errors.rb
+- lib/finale/order.rb
+- lib/finale/shipment.rb
 - lib/finale/version.rb
 homepage: https://github.com/popp0102/finale
 licenses: