gman_client 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57faaa3feff67f2e167a5ca07d212253cf6546ff
+  data.tar.gz: f42a9cb5c4fe3a6bf881ca301e745ea556e58d47
+SHA512:
+  metadata.gz: 5c8f6a583e53b03b85669e46c62f5a31adc6263d4d98f51eb83faad8b8d4adb7e7bf62ecf946ca951418ae6ec143513733a0ebb4bd16dd30341ff7e9b1d51c7d
+  data.tar.gz: f916a6ca562bd24d77f2caf23288efa235d69c28ec86dc065dc001e8c3194ec8421d2121b695369dad6f1685820ff3098dc10e2b68eddf19ecf1bb3d1bd3e0a6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/spec/reports/
+/tmp/
+.idea
+
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+  SupportedStyles:
+    - ruby19
+    - hash_rockets
+
+AllCops:
+ Exclude:
+   - gman_client.gemspec

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+   add_filter 'spec/support'
+end

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+rvm:
+  - "2.1.5"
+  - ruby-head
+script:
+  - export WRAP_URL='http://localhost:3000'
+  - export CLIENT_ID='f444a467ddbbaed52297d61a3edc5efd93e9292fc542058786aa13fa366865a3'
+  - export CLIENT_SECRET='d137a94543da86e52214d3ed86b015f9299ad2fc66681637600afad814cd7d2b'
+  - export TOKEN_URL='http://localhost:3000/oauth/token'
+  - bundle exec rspec -fd
+matrix:
+ allow_failures:
+   - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', :require => false, :group => 'test'
+# Specify your gem's dependencies in gman_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 MichaelAChrisco
+
+MIT License
+
+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/README.md

@@ -0,0 +1,46 @@
+[![Build Status](https://travis-ci.org/westernmilling/gman_client.svg?branch=master)](https://travis-ci.org/westernmilling/gman_client) [![Coverage Status](https://coveralls.io/repos/westernmilling/gman_client/badge.svg)](https://coveralls.io/r/westernmilling/gman_client)
+# GmanClient
+
+Gem hooks into the Grossman API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gman_client', :git => 'git@github.com:michaelachrisco/gman_client.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Make sure to include:
+* WRAP_URL: This URL is the url for the api. Example ```export WRAP_URL="http://example.com"```
+* CLIENT_ID: Doorkeeper App ID. Example: ```export CLIENT_ID="1234567"```
+* CLIENT_SECRET: Doorkeeper App Secret. Example: ```export CLIENT_SECRET="1234567"```
+* TOKEN_URL: URL for token. Example:  ```export TOKEN_URL="http://example.com/oauth/token"```
+
+Or initialize:
+```Ruby
+        gman = Gman::Client.new(:url => "http://example.com",
+                                  :token_url => "1234567",
+                                  :client_id => "1234567",
+                                  :client_secret => "http://example.com/oauth/token"
+        )
+```
+
+How to use:
+```Ruby
+gman.drivers
+gman.driver_commission_histories
+gman.driver_commission_histories_by_paid_date(DATE.new())
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/michaelachrisco/gman_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/gman_client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gman_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gman_client'
+  spec.version       = GmanClient::VERSION
+  spec.authors       = ['MichaelAChrisco', 'josephbridgwaterrowe']
+  spec.email         = ['michaelachrisco@gmail.com']
+  spec.summary       = 'GMAN gem client'
+  spec.description   = 'GMAN gem client for Grossman API'
+  spec.homepage      = 'https://github.com/michaelachrisco/gman_client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'vcr'
+  spec.add_runtime_dependency 'webmock'
+  spec.add_dependency 'blanket_wrapper'
+  spec.add_dependency 'rest-client'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+
+end

data/lib/gman_client/version.rb

@@ -0,0 +1,4 @@
+# VERSION
+module GmanClient
+  VERSION = '0.0.5'
+end

data/lib/gman_client.rb

@@ -0,0 +1,77 @@
+require 'gman_client/version'
+require 'rest_client'
+require 'json'
+require 'blanket'
+
+# GmanClient
+module Gman
+  # grossman +client+ object
+  class Client
+    attr_accessor :url, :token_url, :client_id, :client_secret
+    def initialize(options = {})
+      @url =  options[:url] || ENV['WRAP_URL']
+      @token_url = options[:token_url] || ENV['TOKEN_URL']
+      @client_id = options[:client_id] || ENV['CLIENT_ID']
+      @client_secret = options[:client_secret] || ENV['CLIENT_SECRET']
+    end
+    # class << self
+
+    def drivers
+      response = request.api.v1.drivers.get
+      convert_payload(response)
+    end
+
+    def driver_commission_histories
+      response = request.api.v1.driver_commissions_history.get
+      convert_payload(response)
+    end
+
+    def driver_commission_histories_by_paid_date(paid_date)
+      response = request.api.v1.driver_commissions_history_by_paid_date
+                 .get(:params => { :paid_date => paid_date })
+      convert_payload(response)
+    end
+
+    def inventory_items
+      response = request.api.v1.inventory.items.get
+      convert_payload(response)
+    end
+
+    def inventory_items_like_id_description(item_id, in_item_description)
+      response = request.api.v1.inventory.items_like_id_description
+                 .get(:params => { :item_id => item_id,
+                                   :in_item_description => in_item_description }
+                 )
+      convert_payload(response)
+    end
+
+    def inventory_items_by_id(item_id)
+      response = request.api.v1.inventory.items_by_id
+                 .get(:params => { :item_id => item_id })
+      convert_payload(response)
+    end
+
+    def request
+      token = retrieve_token
+      Blanket.wrap(@url.dup,
+                   :extension => :json,
+                   :headers => {
+                     'Authorization' => "Bearer #{token}" }
+      )
+    end
+
+    def retrieve_token
+      response = RestClient.post @token_url.dup,
+                                 :grant_type => 'client_credentials',
+                                 :client_id => @client_id.dup,
+                                 :client_secret => @client_secret.dup
+
+      JSON.parse(response)['access_token']
+    end
+
+    def convert_payload(response)
+      response.payload.first.nil? ? [response.to_h] : response.map(&:to_h)
+    end
+    # end
+  end
+end

data/spec/lib/driver_commission_history_response_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+RSpec.describe GmanClient do
+  describe '.driver_commission_histories' do
+    let(:response) do
+      VCR.use_cassette('driver_commission_histories') do
+        gman_adapter.driver_commission_histories
+      end
+    end
+
+    subject(:client_response) { response }
+    let(:driver_commission) { client_response.first }
+
+    it 'client response will not be empty' do
+      is_expected.not_to be_empty
+    end
+
+    it 'responds with a hash list' do
+      is_expected.to satisfy {
+                         |h| h.is_a?(Array) && h.all? { |e| e.is_a?(Hash) }
+                     }
+    end
+
+    describe 'first driver' do
+      subject { client_response.first }
+
+      it { is_expected.to have_key(:driver_id) }
+      it { is_expected.to have_key(:backhauls) }
+      it { is_expected.to have_key(:freight_revenue) }
+      it { is_expected.to have_key(:customer_name) }
+      it { is_expected.to have_key(:customer_id) }
+      it { is_expected.to have_key(:delivery_date) }
+      it { is_expected.to have_key(:driver_rate) }
+      it { is_expected.to have_key(:freight_bill_number) }
+      it { is_expected.to have_key(:fuel_surcharge) }
+      it { is_expected.to have_key(:layover) }
+      it { is_expected.to have_key(:movement_type) }
+      it { is_expected.to have_key(:other_hour_dollars) }
+      it { is_expected.to have_key(:order_number_text) }
+      it { is_expected.to have_key(:origin_name) }
+      it { is_expected.to have_key(:paid_date) }
+      it { is_expected.to have_key(:revenue) }
+      it { is_expected.to have_key(:split_rate) }
+      it { is_expected.to have_key(:total_freight_revenue) }
+      it { is_expected.to have_key(:drvrcomh_key) }
+    end
+  end
+  describe '.driver_commission_histories_by_paid_date' do
+    let(:response) do
+      VCR.use_cassette('driver_commission_histories_by_paid_date') do
+        gman_adapter.driver_commission_histories_by_paid_date(
+            Date.new(2014, 01, 01))
+      end
+    end
+    subject(:client_response) { response }
+    let(:driver_commission) { client_response.first }
+    it 'client response will not be empty' do
+      is_expected.not_to be_empty
+    end
+
+    it 'responds with a hash list' do
+      is_expected.to satisfy {
+                         |h| h.is_a?(Array) && h.all? { |e| e.is_a?(Hash) }
+                     }
+    end
+
+    describe 'first driver' do
+      subject { client_response.first }
+
+      it { is_expected.to have_key(:driver_id) }
+      it { is_expected.to have_key(:backhauls) }
+      it { is_expected.to have_key(:freight_revenue) }
+      it { is_expected.to have_key(:customer_name) }
+      it { is_expected.to have_key(:customer_id) }
+      it { is_expected.to have_key(:delivery_date) }
+      it { is_expected.to have_key(:driver_rate) }
+      it { is_expected.to have_key(:freight_bill_number) }
+      it { is_expected.to have_key(:fuel_surcharge) }
+      it { is_expected.to have_key(:layover) }
+      it { is_expected.to have_key(:movement_type) }
+      it { is_expected.to have_key(:other_hour_dollars) }
+      it { is_expected.to have_key(:order_number_text) }
+      it { is_expected.to have_key(:origin_name) }
+      it { is_expected.to have_key(:paid_date) }
+      it { is_expected.to have_key(:revenue) }
+      it { is_expected.to have_key(:split_rate) }
+      it { is_expected.to have_key(:total_freight_revenue) }
+      it { is_expected.to have_key(:drvrcomh_key) }
+      it { is_expected.to have_value(Date.new(2014, 01, 01).to_s) }
+    end
+  end
+end

data/spec/lib/driver_response_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe GmanClient do
+  describe '.drivers' do
+    let(:response) do
+      VCR.use_cassette('drivers') do
+        gman_adapter.drivers
+      end
+    end
+    subject(:client_response) { response }
+    let(:driver) { client_response.first }
+
+    it 'client response will not be empty' do
+      is_expected.not_to be_empty
+    end
+
+    it 'responds with a hash list' do
+      is_expected.to satisfy {
+                         |h| h.is_a?(Array) && h.all? { |e| e.is_a?(Hash) }
+                     }
+    end
+
+    describe 'first driver' do
+      subject { client_response.first }
+      its(:keys) do
+        is_expected.to eq([:driver_id,
+                           :active_fg,
+                           :driver_type,
+                           :sub_hauler_fg,
+                           :first_name,
+                           :last_name])
+      end
+    end
+  end
+end

data/spec/lib/inventory_item_response_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+RSpec.describe GmanClient do
+  describe '.inventory_items' do
+    let(:response) do
+      VCR.use_cassette('inventory_items') do
+        gman_adapter.inventory_items
+      end
+    end
+
+    subject(:client_response) { response }
+    let(:driver_commission) { client_response.first }
+
+    it 'client response will not be empty' do
+      is_expected.not_to be_empty
+    end
+
+    it 'responds with a hash list' do
+      is_expected.to satisfy {
+                         |h| h.is_a?(Array) && h.all? { |e| e.is_a?(Hash) }
+                     }
+    end
+
+    describe 'first item' do
+      subject { client_response.first }
+
+      it { is_expected.to have_key(:item_id) }
+      it { is_expected.to have_key(:in_item_description) }
+    end
+  end
+
+  describe '.inventory_items_like_id_description' do
+    let(:response) do
+      VCR.use_cassette('inventory_items_like_id_description') do
+        gman_adapter.inventory_items_like_id_description(9370, 'Rachelle')
+      end
+    end
+    subject(:client_response) { response }
+    let(:driver_commission) { client_response.first }
+    it 'client response will not be empty' do
+      is_expected.not_to be_empty
+    end
+
+    it 'responds with a hash list' do
+      is_expected.to satisfy {
+                         |h| h.is_a?(Array) && h.all? { |e| e.is_a?(Hash) }
+                     }
+    end
+
+    describe 'first item' do
+      subject { client_response.first }
+
+      it { is_expected.to have_key(:item_id) }
+      it { is_expected.to have_key(:in_item_description) }
+      it { is_expected.to have_value(9370) }
+      it { is_expected.to have_value('Rachelle') }
+    end
+  end
+
+  describe '.inventory_items_by_id' do
+    let(:response) do
+      VCR.use_cassette('inventory_items_by_id') do
+        gman_adapter.inventory_items_by_id(9370)
+      end
+    end
+    subject(:client_response) { response }
+    let(:driver_commission) { client_response.first }
+    it 'client response will not be empty' do
+      is_expected.not_to be_empty
+    end
+
+    it 'responds with a hash list' do
+      is_expected.to satisfy {
+                         |h| h.is_a?(Array) && h.all? { |e| e.is_a?(Hash) }
+                     }
+    end
+
+    describe 'first item' do
+      subject { client_response.first }
+
+      it { is_expected.to have_key(:item_id) }
+      it { is_expected.to have_key(:in_item_description) }
+      it { is_expected.to have_value(9370) }
+      it { is_expected.to have_value('Rachelle') }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'coveralls'
+Coveralls.wear!
+require 'rspec/its'
+require 'spec_helper'
+require 'gman_client'
+require 'vcr'
+require 'httparty'
+require 'webmock'
+require 'support/vcr'
+require 'support/gman_adapter'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/gman_adapter.rb

@@ -0,0 +1,14 @@
+def gman_adapter
+  url = 'http://localhost:3000'
+  token_url = 'http://localhost:3000/oauth/token'
+  # rubocop:disable Metrics/LineLength
+  client_id = 'd137a94543da86e52214d3ed86b015f9299ad2fc66681637600afad814cd7d2b'
+  client_secret = 'f444a467ddbbaed52297d61a3edc5efd93e9292fc542058786aa13fa366865a3'
+  # rubocop:enable Metrics/LineLength
+
+  Gman::Client.new(:url => url,
+                   :token_url => token_url,
+                   :client_id => client_id,
+                   :client_secret => client_secret
+  )
+end

data/spec/support/vcr.rb

@@ -0,0 +1,23 @@
+require 'vcr'
+
+# VCR.configure do |c|
+#   c.hook_into :webmock
+#   c.cassette_library_dir = 'spec/support/vcr_cassettes'
+#   c.configure_rspec_metadata!
+#   c.allow_http_connections_when_no_cassette = true if real_requests
+#   c.default_cassette_options = {:record => :new_episodes}
+# end
+
+real_requests = ENV['REAL_REQUESTS']
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = true if real_requests
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    VCR.eject_cassette
+  end if real_requests
+end