gman_client 0.0.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c1961bbbdfb8456af992da97bdc4c62be5c55f6
-  data.tar.gz: 698d78209642e4be8dce4959929b033f196fff3f
+  metadata.gz: 0aa6d21aa0d0f6fe345c586c397140edcf677c11
+  data.tar.gz: 84497c9c1c9b0bec166d29f1a40625c268b06318
 SHA512:
-  metadata.gz: da90786bdb30d56ebc16cc169931ef4fbe2eec28df962f92833db7e9b47d4f4fee772b42d1d5a39f4d62896825b016a177d821ba45fdff201bcf49dec8cb28b3
-  data.tar.gz: fbca6812bef81e0265f6fa84f8de67b82244e8c55a07d12032b0ccd915b7adddebfcfba4801fb120d4ca4c3cdc8c160caba0715de008aacd965d43bc8ba310fc
+  metadata.gz: bec26eb20558386e4367b87a82a34dbfdd26cbab4f82c6d4f3e4a7dc475541ad102e0e598644b267209c5273340576f276d942e9eea9e474926a31830cb678e6
+  data.tar.gz: 800098bb6f74c540a2e484a6e1387d092c4e6f82fe51eeb9309a47c163bd22a0854ef6e5442ddf0b5fddac448b713e59994ccac92f058635b8f77089d4e3a682

data/.gitignore

@@ -4,6 +4,7 @@
 /_yardoc/
 /coverage/
 /doc/
+/pkg
 /spec/reports/
 /tmp/
 .rspec

data/lib/gman/client.rb

@@ -1,6 +1,8 @@
 module Gman
   class Client
+    include GmanClient::Api::CustomerContracts
     include GmanClient::Api::Orders
+    include GmanClient::Api::HealthCheck
     include GmanClient::CommodityMerchandising::Contracts
     include GmanClient::Utility
 

data/lib/gman_client/api/customer_contracts.rb

@@ -0,0 +1,20 @@
+module GmanClient
+  module Api
+    module CustomerContracts
+      # Retrieves customer contracts
+      #
+      # @param [Hash] parameters to filter the orders
+      def customer_contracts(filter_params)
+        response = attempt(@retry_attempts) do
+          request
+            .api
+            .v1
+            .customer_contracts
+            .get(params: { q: filter_params })
+        end
+
+        response.map(&:to_h)
+      end
+    end
+  end
+end

data/lib/gman_client/api/health_check.rb

@@ -0,0 +1,13 @@
+module GmanClient
+  module Api
+    # HealthCheck API
+    module HealthCheck
+      # Retrieve a health check
+      def health_check
+        response = request.api.v1.health_check.get
+
+        response.to_h[:health_check] == 'Passed'
+      end
+    end
+  end
+end

data/lib/gman_client/version.rb

@@ -1,3 +1,3 @@
 module GmanClient
-  VERSION = '0.0.10'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/gman_client.rb

@@ -1,4 +1,6 @@
+require 'gman_client/api/customer_contracts'
 require 'gman_client/api/orders'
+require 'gman_client/api/health_check'
 require 'gman_client/commodity_merchandising/contracts'
 require 'gman_client/utility'
 require 'gman_client/version'

data/spec/lib/client/customer_contracts_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'webmock'
+
+RSpec.describe Gman::Client do
+  include WebMock::API
+
+  let(:client) do
+    Gman::Client.new(
+      url: stubbed_url,
+      client_id: 'client_id',
+      client_secret: 'client_secret'
+    )
+  end
+
+  let(:customer_contracts_hash) do
+    [
+      {
+        contract_id: '50000000',
+        contract_type: 'Sale',
+        customer_id: '00010000',
+        location_id: '01'
+      },
+      {
+        contract_id: '50000100',
+        contract_type: 'Sale',
+        customer_id: '00010000',
+        location_id: '01'
+      }
+    ]
+  end
+
+  describe '#customer_contracts' do
+    let(:described) { client.customer_contracts(params) }
+    let(:stubbed_url) { 'http://test.local' }
+
+    context 'when customer contracts are found' do
+      before do
+        stub_request(:post, "#{stubbed_url}/oauth/token")
+          .to_return(
+            body: { access_token: access_token }.to_json, status: 200
+          )
+        stub_request(
+          :get, "#{stubbed_url}/api/v1/customer_contracts.json?#{query_string}"
+        )
+          .to_return(body: customer_contracts_hash.to_json, status: 200)
+      end
+      let(:access_token) { SecureRandom.uuid }
+      let(:params) do
+        {
+          customer_id: '00010000'
+        }
+      end
+      let(:query_string) do
+        params.map { |k, v| "q[#{k}]=#{v}" }.join('&')
+      end
+
+      describe 'response' do
+        subject { described }
+
+        it { is_expected.to be_kind_of(Array) }
+        its(:size) { is_expected.to eq 2 }
+
+        describe 'first match' do
+          subject { described[0] }
+
+          its([:contract_id]) do
+            is_expected.to eq customer_contracts_hash[0][:contract_id]
+          end
+          its([:contract_type]) do
+            is_expected.to eq customer_contracts_hash[0][:contract_type]
+          end
+          its([:customer_id]) do
+            is_expected.to eq customer_contracts_hash[0][:customer_id]
+          end
+          its([:location_id]) do
+            is_expected.to eq customer_contracts_hash[0][:location_id]
+          end
+        end
+        describe 'second match' do
+          subject { described[1] }
+
+          its([:contract_id]) do
+            is_expected.to eq customer_contracts_hash[1][:contract_id]
+          end
+          its([:contract_type]) do
+            is_expected.to eq customer_contracts_hash[1][:contract_type]
+          end
+          its([:customer_id]) do
+            is_expected.to eq customer_contracts_hash[1][:customer_id]
+          end
+          its([:location_id]) do
+            is_expected.to eq customer_contracts_hash[1][:location_id]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/client/health_check_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'webmock'
+
+RSpec.describe Gman::Client do
+  include WebMock::API
+
+  let(:client) do
+    Gman::Client.new(
+      url: stubbed_url,
+      client_id: 'client_id',
+      client_secret: 'client_secret'
+    )
+  end
+
+  describe '#health_check' do
+    let(:described) { client.health_check }
+    let(:access_token) { SecureRandom.uuid }
+    let(:stubbed_url) { 'http://test.local' }
+
+    before do
+      stub_request(:post, "#{stubbed_url}/oauth/token")
+        .to_return(
+          body: { access_token: access_token }.to_json, status: 200
+        )
+      stub_request(
+        :get, "#{stubbed_url}/api/v1/health_check.json"
+      )
+        .to_return(body: health_check_hash.to_json, status: 200)
+    end
+    let(:access_token) { SecureRandom.uuid }
+
+    subject do
+      described
+    end
+
+    context 'when the health check is successful' do
+      let(:health_check_hash) { { health_check: 'Passed' } }
+
+      it 'should be true' do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context 'when the health check fails' do
+      let(:health_check_hash) { { health_check: 'Failed' } }
+
+      it 'should be false' do
+        expect(subject).to eq(false)
+      end
+    end
+  end
+end

data/spec/lib/client/orders_spec.rb

@@ -85,7 +85,7 @@ RSpec.describe Gman::Client do
         }
       end
 
-      it 'should respond with a Hash' do
+      it 'should respond with an Array' do
         expect(subject).to be_kind_of(Array)
       end
 

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
-
 require 'rspec/its'
 require 'spec_helper'
 require 'gman_client'
 require 'httparty'
 require 'webmock'
+require 'securerandom'
 
 Dir[File.join(GmanClient.root, 'spec/support/**/*.rb')].each { |f| require f }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gman_client
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.2.0
 platform: ruby
 authors:
 - MichaelAChrisco
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -171,19 +171,15 @@ files:
 - gman_client.gemspec
 - lib/gman/client.rb
 - lib/gman_client.rb
+- lib/gman_client/api/customer_contracts.rb
+- lib/gman_client/api/health_check.rb
 - lib/gman_client/api/orders.rb
 - lib/gman_client/commodity_merchandising/contracts.rb
 - lib/gman_client/inventory/items.rb
 - lib/gman_client/utility.rb
 - lib/gman_client/version.rb
-- pkg/gman_client-0.0.1.gem
-- pkg/gman_client-0.0.2.gem
-- pkg/gman_client-0.0.3.gem
-- pkg/gman_client-0.0.4.gem
-- pkg/gman_client-0.0.5.gem
-- pkg/gman_client-0.0.7.gem
-- pkg/gman_client-0.0.8.gem
-- pkg/gman_client-0.0.9.gem
+- spec/lib/client/customer_contracts_spec.rb
+- spec/lib/client/health_check_spec.rb
 - spec/lib/client/order_spec.rb
 - spec/lib/client/orders_spec.rb
 - spec/lib/client_contracts_spec.rb
@@ -221,11 +217,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Grossman API Client for Ruby
 test_files:
+- spec/lib/client/customer_contracts_spec.rb
+- spec/lib/client/health_check_spec.rb
 - spec/lib/client/order_spec.rb
 - spec/lib/client/orders_spec.rb
 - spec/lib/client_contracts_spec.rb