onfleet-ruby 0.1.4 → 0.1.5

data/spec/onfleet/destination_spec.rb

@@ -0,0 +1,62 @@
+RSpec.describe Onfleet::Destination do
+  let(:destination) { described_class.new(params) }
+  let(:params) { { id: 'a-destination', address: address_params } }
+  let(:address_params) { { street: '123 Main', city: 'Foo', state: 'TX' } }
+
+  describe ".create" do
+    subject { -> { described_class.create(params) } }
+    it_should_behave_like Onfleet::Actions::Create, path: 'destinations'
+  end
+
+  describe ".get" do
+    subject { -> { described_class.get(id) } }
+    let(:id) { 'a-destination' }
+    it_should_behave_like Onfleet::Actions::Get, path: 'destinations/a-destination'
+  end
+
+  describe ".query_by_metadata" do
+    subject { -> { described_class.query_by_metadata(metadata) } }
+    let(:metadata) { [{ name: 'color', type: 'string', value: 'ochre' }] }
+    it_should_behave_like Onfleet::Actions::QueryMetadata, path: 'destinations'
+  end
+
+  describe "#save" do
+    subject { -> { destination.save } }
+
+    context "with an ID attribute" do
+      before { expect(params[:id]).to be }
+      it_should_behave_like Onfleet::Actions::Update, path: 'destinations/a-destination'
+    end
+
+    context "without an ID attribute" do
+      let(:params) { { address: address_params } }
+      it_should_behave_like Onfleet::Actions::Create, path: 'destinations'
+    end
+  end
+
+  describe "#address" do
+    subject { destination.address }
+
+    context "when initialized with address params" do
+      let(:address_params) do
+        {
+          number: '123',
+          street: 'Main St.',
+          apartment: '',
+          city: 'Foo',
+          state: 'TX',
+          postalCode: '99999',
+          country: 'United States'
+        }
+      end
+      its(:number) { should == '123' }
+      its(:postal_code) { should == '99999' }
+    end
+
+    context "when initialized with no address params" do
+      let(:address_params) { nil }
+      it { should be_nil }
+    end
+  end
+end
+

data/spec/onfleet/organization_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe Onfleet::Organization do
+  let(:organization) { described_class.new(params) }
+  let(:params) { { id: 'an-org' } }
+
+  describe ".get" do
+    subject { -> { described_class.get } }
+    it_should_behave_like Onfleet::Actions::Get, path: 'organization'
+  end
+
+  describe ".get_delegatee_details" do
+    subject { -> { described_class.get_delegatee_details(id) } }
+    let(:id) { 'my-org' }
+    it_should_behave_like Onfleet::Actions::Get, path: 'organizations/my-org'
+  end
+
+  %i[id name email country timezone time_created time_last_modified].each do |attr|
+    describe "##{attr}" do
+      subject { organization.public_send(attr) }
+      let(:params) { { attr => value } }
+      let(:value) { 'pizza' }
+      it { should == value }
+    end
+  end
+end
+

data/spec/onfleet/recipient_spec.rb

@@ -0,0 +1,75 @@
+RSpec.describe Onfleet::Recipient do
+  let(:recipient) { described_class.new(params) }
+  let(:params) { { id: 'a-recipient', name: 'Recipient Jones' } }
+
+  describe ".create" do
+    subject { -> { described_class.create(params) } }
+    it_should_behave_like Onfleet::Actions::Create, path: 'recipients'
+
+    context "with the `skip_sms_notifications` attribute" do
+      set_up_request_stub(:post, 'recipients')
+      let(:params) { { skip_sms_notifications: true } }
+      let(:response_body) { { id: 'an-object' } }
+
+      it "should camelize the attribute name properly" do
+        subject.call
+        expect(
+          a_request(:post, url).with(body: { 'skipSMSNotifications' => true }.to_json)
+        ).to have_been_made.once
+      end
+    end
+  end
+
+  describe ".get" do
+    subject { -> { described_class.get(id) } }
+    let(:id) { 'a-recipient' }
+    it_should_behave_like Onfleet::Actions::Get, path: 'recipients/a-recipient'
+  end
+
+  describe ".update" do
+    subject { -> { described_class.update(id, params) } }
+    let(:id) { 'a-recipient' }
+    it_should_behave_like Onfleet::Actions::Update, path: 'recipients/a-recipient'
+
+    context "with the `skip_sms_notifications` attribute" do
+      set_up_request_stub(:put, 'recipients/a-recipient')
+      let(:params) { { id: 'a-recipient', skip_sms_notifications: true } }
+      let(:response_body) { { id: 'an-object' } }
+
+      it "should camelize the attribute name properly" do
+        subject.call
+        expect(
+          a_request(:put, url).with(body: { id: 'a-recipient', 'skipSMSNotifications' => true }.to_json)
+        ).to have_been_made.once
+      end
+    end
+  end
+
+  describe ".find" do
+    subject { -> { described_class.find(attribute, value) } }
+    let(:attribute) { 'name' }
+    let(:value) { 'Ma Bell' }
+    it_should_behave_like Onfleet::Actions::Find, path: "recipients/name/Ma+Bell"
+  end
+
+  describe ".query_by_metadata" do
+    subject { -> { described_class.query_by_metadata(metadata) } }
+    let(:metadata) { [{ name: 'color', type: 'string', value: 'ochre' }] }
+    it_should_behave_like Onfleet::Actions::QueryMetadata, path: 'recipients'
+  end
+
+  describe "#save" do
+    subject { -> { recipient.save } }
+
+    context "with an ID attribute" do
+      before { expect(params[:id]).to be }
+      it_should_behave_like Onfleet::Actions::Update, path: 'recipients/a-recipient'
+    end
+
+    context "without an ID attribute" do
+      let(:params) { { name: 'Recipient Jones' } }
+      it_should_behave_like Onfleet::Actions::Create, path: 'recipients'
+    end
+  end
+end
+

data/spec/onfleet/task_spec.rb

@@ -0,0 +1,123 @@
+RSpec.describe Onfleet::Task do
+  let(:task) { described_class.new(params) }
+  let(:params) { { id: 'a-task', short_id: 'at', recipients: ['jeff'] } }
+
+  describe ".list" do
+    subject { -> { described_class.list(query_params) } }
+
+    context "with no filter" do
+      let(:query_params) { nil }
+      it_should_behave_like Onfleet::Actions::List, path: 'tasks'
+    end
+
+    context "with query params" do
+      let(:query_params) { { food: 'pizza', topping: 'mushroom' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'tasks?food=pizza&topping=mushroom'
+    end
+
+    context "with a URL-unsafe query param" do
+      let(:query_params) { { food: 'green eggs & ham' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'tasks?food=green+eggs+%26+ham'
+    end
+  end
+
+  describe ".create" do
+    subject { -> { described_class.create(params) } }
+    it_should_behave_like Onfleet::Actions::Create, path: 'tasks'
+
+    context "with the skip_sms_notification override attribute" do
+      set_up_request_stub(:post, 'tasks')
+      let(:params) { { recipient_skip_sms_notifications: true } }
+      let(:response_body) { { id: 'an-object' } }
+
+      it "should camelize the attribute name properly" do
+        pending('The SMS acronym does not camelize consistently')
+        subject.call
+        expect(
+          a_request(:post, url).with(body: { recipientSkipSMSNotifications: true }.to_json)
+        ).to have_been_made.once
+      end
+    end
+
+    context "with barcode attributes" do
+      set_up_request_stub(:post, 'tasks')
+      let(:params) { { barcodes: [{ data: 'abc', block_completion: true }] } }
+      let(:response_body) { { id: 'an-object' } }
+
+      it "should camelize the attribute name properly" do
+        pending('JSON subkeys of non-Onfleet objects do not camelize')
+        subject.call
+        expect(
+          a_request(:post, url).with(body: { barcodes: [{ data: 'abc', 'blockCompletion' => true }] }.to_json)
+        ).to have_been_made.once
+      end
+    end
+  end
+
+  describe ".get" do
+    subject { -> { described_class.get(id) } }
+    let(:id) { 'a-task' }
+    it_should_behave_like Onfleet::Actions::Get, path: 'tasks/a-task'
+  end
+
+  describe ".update" do
+    subject { -> { described_class.update(id, params) } }
+    let(:id) { 'a-task' }
+    it_should_behave_like Onfleet::Actions::Update, path: 'tasks/a-task'
+
+    context "with the skip_sms_notification override attribute" do
+      set_up_request_stub(:put, 'tasks/a-task')
+      let(:params) { { id: 'a-task', recipient_skip_sms_notifications: true } }
+      let(:response_body) { { id: 'an-object' } }
+
+      it "should camelize the attribute name properly" do
+        pending('The SMS acronym does not camelize consistently')
+        subject.call
+        expect(
+          a_request(:put, url).with(body: { recipientSkipSMSNotifications: true }.to_json)
+        ).to have_been_made.once
+      end
+    end
+
+    context "with barcode attributes" do
+      set_up_request_stub(:put, 'tasks/a-task')
+      let(:params) { { id: 'a-task', barcodes: [{ data: 'abc', block_completion: true }] } }
+      let(:response_body) { { id: 'an-object' } }
+
+      it "should camelize the attribute name properly" do
+        pending('JSON subkeys of non-Onfleet objects do not camelize')
+        subject.call
+        expect(
+          a_request(:put, url).with(body: { barcodes: [{ data: 'abc', 'blockCompletion' => true }] }.to_json)
+        ).to have_been_made.once
+      end
+    end
+  end
+
+  describe ".delete" do
+    subject { -> { described_class.delete(id) } }
+    let(:id) { 'an-task' }
+    it_should_behave_like Onfleet::Actions::Delete, path: 'tasks/an-task'
+  end
+
+  describe ".query_by_metadata" do
+    subject { -> { described_class.query_by_metadata(metadata) } }
+    let(:metadata) { [{ name: 'color', type: 'string', value: 'ochre' }] }
+    it_should_behave_like Onfleet::Actions::QueryMetadata, path: 'tasks'
+  end
+
+  describe "#save" do
+    subject { -> { task.save } }
+
+    context "with an ID attribute" do
+      before { expect(params[:id]).to be }
+      it_should_behave_like Onfleet::Actions::Update, path: 'tasks/a-task'
+    end
+
+    context "without an ID attribute" do
+      let(:params) { { short_id: 'at', recipients: ['jeff'] } }
+      it_should_behave_like Onfleet::Actions::Create, path: 'tasks'
+    end
+  end
+end
+

data/spec/onfleet/team_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe Onfleet::Team do
+  let(:team) { described_class.new(params) }
+  let(:params) { { id: 'a-team', name: 'Detroit Redwings' } }
+
+  describe ".list" do
+    subject { -> { described_class.list(query_params) } }
+
+    context "with no filter" do
+      let(:query_params) { nil }
+      it_should_behave_like Onfleet::Actions::List, path: 'teams'
+    end
+
+    context "with query params" do
+      let(:query_params) { { food: 'pizza', topping: 'mushroom' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'teams?food=pizza&topping=mushroom'
+    end
+
+    context "with a URL-unsafe query param" do
+      let(:query_params) { { food: 'green eggs & ham' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'teams?food=green+eggs+%26+ham'
+    end
+  end
+
+  describe ".get" do
+    subject { -> { described_class.get(id) } }
+    let(:id) { 'a-team' }
+    it_should_behave_like Onfleet::Actions::Get, path: 'teams/a-team'
+  end
+end
+

data/spec/onfleet/webhook_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Onfleet::Webhook do
+  let(:webhook) { described_class.new(params) }
+  let(:params) { { id: 'a-webhook', url: 'https://example.com', is_enabled: true } }
+
+  describe ".list" do
+    subject { -> { described_class.list(query_params) } }
+
+    context "with no filter" do
+      let(:query_params) { nil }
+      it_should_behave_like Onfleet::Actions::List, path: 'webhooks'
+    end
+
+    context "with query params" do
+      let(:query_params) { { food: 'pizza', topping: 'mushroom' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'webhooks?food=pizza&topping=mushroom'
+    end
+
+    context "with a URL-unsafe query param" do
+      let(:query_params) { { food: 'green eggs & ham' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'webhooks?food=green+eggs+%26+ham'
+    end
+  end
+
+  describe ".create" do
+    subject { -> { described_class.create(params) } }
+    it_should_behave_like Onfleet::Actions::Create, path: 'webhooks'
+  end
+
+  describe ".delete" do
+    subject { -> { described_class.delete(id) } }
+    let(:id) { 'a-webhook' }
+    it_should_behave_like Onfleet::Actions::Delete, path: 'webhooks/a-webhook'
+  end
+
+  describe "#save" do
+    subject { -> { webhook.save } }
+
+    context "with an ID attribute" do
+      before { expect(params[:id]).to be }
+      it_should_behave_like Onfleet::Actions::Update, path: 'webhooks/a-webhook'
+    end
+
+    context "without an ID attribute" do
+      let(:params) { { name: 'An Webhook' } }
+      it_should_behave_like Onfleet::Actions::Create, path: 'webhooks'
+    end
+  end
+end
+

data/spec/onfleet/worker_spec.rb

@@ -0,0 +1,67 @@
+RSpec.describe Onfleet::Worker do
+  let(:worker) { described_class.new(params) }
+  let(:params) { { id: 'a-worker', name: 'F. Prefect', phone: '5551212' } }
+
+  describe ".list" do
+    subject { -> { described_class.list(query_params) } }
+
+    context "with no filter" do
+      let(:query_params) { nil }
+      it_should_behave_like Onfleet::Actions::List, path: 'workers'
+    end
+
+    context "with query params" do
+      let(:query_params) { { food: 'pizza', topping: 'mushroom' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'workers?food=pizza&topping=mushroom'
+    end
+
+    context "with a URL-unsafe query param" do
+      let(:query_params) { { food: 'green eggs & ham' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'workers?food=green+eggs+%26+ham'
+    end
+  end
+
+  describe ".create" do
+    subject { -> { described_class.create(params) } }
+    it_should_behave_like Onfleet::Actions::Create, path: 'workers'
+  end
+
+  describe ".get" do
+    subject { -> { described_class.get(id) } }
+    let(:id) { 'a-worker' }
+    it_should_behave_like Onfleet::Actions::Get, path: 'workers/a-worker'
+  end
+
+  describe ".update" do
+    subject { -> { described_class.update(id, params) } }
+    let(:id) { 'a-worker' }
+    it_should_behave_like Onfleet::Actions::Update, path: 'workers/a-worker'
+  end
+
+  describe ".delete" do
+    subject { -> { described_class.delete(id) } }
+    let(:id) { 'a-worker' }
+    it_should_behave_like Onfleet::Actions::Delete, path: 'workers/a-worker'
+  end
+
+  describe ".query_by_metadata" do
+    subject { -> { described_class.query_by_metadata(metadata) } }
+    let(:metadata) { [{ name: 'color', type: 'string', value: 'ochre' }] }
+    it_should_behave_like Onfleet::Actions::QueryMetadata, path: 'workers'
+  end
+
+  describe "#save" do
+    subject { -> { worker.save } }
+
+    context "with an ID attribute" do
+      before { expect(params[:id]).to be }
+      it_should_behave_like Onfleet::Actions::Update, path: 'workers/a-worker'
+    end
+
+    context "without an ID attribute" do
+      let(:params) { { name: 'An Worker' } }
+      it_should_behave_like Onfleet::Actions::Create, path: 'workers'
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,2 +1,78 @@
-require 'onfleet-ruby'
-require File.expand_path('../test_data', __FILE__)
+require 'rspec/its'
+require 'webmock/rspec'
+require File.expand_path(File.join('..', 'lib', 'onfleet-ruby'), __dir__)
+
+Dir.glob(File.expand_path(File.join('support', '**', '*.rb'), __dir__)).each { |file| require file }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.before { Onfleet.api_key = 'TEST API KEY' }
+end
+