finale 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39d6ca5d2a4c1870b4848e13f98b758537ecc1eb
-  data.tar.gz: a93d9394f35f9d8423c38690f858cd97f69d691f
+  metadata.gz: 9c2549196c2c78881f1fdc2b48e0da4552a7821f
+  data.tar.gz: a90de795f5c19f9de201081657f8b8bf77009fbb
 SHA512:
-  metadata.gz: b2238fa55f6c4c94a70a20d0fa8d2ea59c17c83955c9774c1c66dc28eb8095bb2d4dc46ecc89fb0bfc14e9fa03a7f981ffad9bda906dfdc31e662d4af395c0ec
-  data.tar.gz: 10f578be0f6f609a1bd037a83b04ceed1b28438f02e07cc6e89b35eed34d4e395172686c8484f4b95a2c33d644d82dd48e5816136f05f1fd823d4dda4fc8301b
+  metadata.gz: 3431646ac3855e4b8e48f19695d8e9b14a9e1733cc58f5428e643b741ca0d5da63af40765d4a7755184c39aeac1f256cda238f1c0349b3a6ce3c2f8466dc4b82
+  data.tar.gz: 452f6d2b5ade9bbb2f3751b40f8e6cfe362c03f7c1ea47959293d25128751dbd76bf7a340e9870a20816f3c8a482a8546fde72ecf15e03ef7fdd40bf23dcbd7d

data/README.md

@@ -1,3 +1,8 @@
+[![Version      ](https://img.shields.io/gem/v/finale.svg?maxAge=2592000)](https://rubygems.org/gems/finale)
+[![Build Status ](https://travis-ci.org/popp0102/finale.svg)](https://travis-ci.org/popp0102/finale)
+[![Code Climate ](https://api.codeclimate.com/v1/badges/7c7d7c83bde6c288f5e8/maintainability)](https://codeclimate.com/github/popp0102/finale/maintainability)
+[![Test Coverage](https://codeclimate.com/github/popp0102/finale/badges/coverage.svg)](https://codeclimate.com/github/popp0102/finale/coverage)
+
 # Finale
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/finale`. To experiment with that code, run `bin/console` for an interactive prompt.

data/lib/finale.rb

@@ -1,4 +1,7 @@
 require "rest-client"
+require "json"
+require "base64"
+require "active_support/all"
 
 require "finale/version"
 require "finale/errors"
@@ -10,10 +13,10 @@ module Finale
     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)
+    def initialize(account)
       @cookies       = nil
       @request_count = 0
-      @company       = company
+      @account       = account
       @login_url     = construct_url(:auth)
       @order_url     = construct_url(:order)
       @shipment_url  = construct_url(:shipment)
@@ -28,19 +31,20 @@ module Finale
       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_orders(filter: nil)
+      resp_orders = request(verb: :GET, url: @order_url, filter: filter )
+      rows        = column_major_to_row_major(resp_orders)
+      orders      = rows.map { |r| Order.new(r) }
+      orders
+    end
+
     def get_shipments(order)
-      order.shipment_urls.map do |suffix_url|
+      order.shipmentUrlList.map do |suffix_url|
         url      = "#{BASE_URL}#{suffix_url}"
         response = request(verb: :GET, url: url)
         Shipment.new(response)
@@ -49,11 +53,24 @@ module Finale
 
     private
 
+    def column_major_to_row_major(column_major)
+      row_major = []
+      keys      = column_major.keys
+      values    = column_major.values || [[]]
+      num_cols  = values.count == 0 ? 0 : values.first.count
+      num_cols.times do
+        rowvals   = keys.map { |key| column_major[key].shift }
+        row       = Hash[keys.zip(rowvals)]
+        row_major << row
+      end
+      row_major
+    end
+
     def construct_url(resource)
-      "#{BASE_URL}/#{@company}/api/#{resource}"
+      "#{BASE_URL}/#{@account}/api/#{resource}"
     end
 
-    def request(verb: nil, url: nil, payload: nil)
+    def request(verb: nil, url: nil, payload: nil, filter: nil)
       raise MaxRequests.new(MAX_REQUESTS) if @request_count >= MAX_REQUESTS
       raise NotLoggedIn.new(verb: verb, url: url) unless verb == :LOGIN || !@cookies.nil?
 
@@ -62,7 +79,14 @@ module Finale
         response = RestClient.post(@login_url, payload)
         @cookies = response.cookies
       when :GET
-        response = RestClient.get(url, cookies: @cookies)
+        params = {}
+
+        if filter.present?
+          encoded_filter = Base64.encode64(filter.to_json)
+          params.merge!(filter: encoded_filter)
+        end
+
+        response = RestClient.get(url, cookies: @cookies, params: params)
       when :POST
         response = RestClient.post(url, cookies: @cookies)
       end

data/lib/finale/order.rb

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

data/lib/finale/shipment.rb

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

data/lib/finale/version.rb

@@ -1,3 +1,3 @@
 module Finale
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: finale
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
-- popp0102
+- Jason Poppler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,24 +136,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.10'
-description: A client to interact with the Finale Inventory System.
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
 email:
 - popp0102@getnotion.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- finale.gemspec
 - lib/finale.rb
 - lib/finale/errors.rb
 - lib/finale/order.rb

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/Gemfile.lock
-*.swp
-*.swo
-*.swn
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.4
-before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at jason@getnotion.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in finale.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 jpoppler
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "finale"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/finale.gemspec

@@ -1,43 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "finale/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "finale"
-  spec.version       = Finale::VERSION
-  spec.authors       = ["popp0102"]
-  spec.email         = ["popp0102@getnotion.com"]
-
-  spec.summary       = 'A client to interact with the Finale Inventory System.'
-  spec.description   = 'A client to interact with the Finale Inventory System.'
-  spec.homepage      = "https://github.com/popp0102/finale"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  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