onfleet-ruby 0.1.4 → 0.1.5

data/spec/support/http_requests/shared_examples.rb

@@ -0,0 +1,126 @@
+RSpec.shared_examples_for "an action that makes a request to Onfleet" do |method:|
+  it "should include the base64-encoded API key in the auth header" do
+    encoded_api_key = Base64.urlsafe_encode64(Onfleet.api_key)
+
+    subject.call
+    expect(
+      a_request(method, url).with(headers: { 'Authorization' => "Basic #{encoded_api_key}" })
+    ).to have_been_made.once
+  end
+
+  it "should specify that it will accept JSON" do
+    subject.call
+    expect(
+      a_request(method, url).with(headers: { 'Accept' => 'application/json' })
+    ).to have_been_made.once
+  end
+
+  if %i[post put patch].include?(method.to_sym)
+    it "should set the content type to JSON" do
+      subject.call
+      expect(
+        a_request(method, url).with(headers: { 'Content-Type' => 'application/json' })
+      ).to have_been_made.once
+    end
+  end
+
+  context "without valid authentication" do
+    let(:response) { { status: 401, body: { message: 'bad auth' }.to_json } }
+    it { should raise_error(Onfleet::AuthenticationError) }
+  end
+
+  context "without valid authorization" do
+    let(:response) { { status: 404, body: { message: 'bad auth' }.to_json } }
+    it { should raise_error(Onfleet::InvalidRequestError) }
+  end
+
+  context "when an unspecified error occurs" do
+    let(:response) { { status: 500, body: { message: 'all bad' }.to_json } }
+    it { should raise_error(Onfleet::OnfleetError) }
+  end
+end
+
+RSpec.shared_examples_for Onfleet::Actions::Get do |path:|
+  set_up_request_stub(:get, path)
+  let(:response_body) { { id: 'an-object' } }
+  it_should_behave_like "an action that makes a request to Onfleet", method: :get
+end
+
+RSpec.shared_examples_for Onfleet::Actions::List do |path:|
+  set_up_request_stub(:get, path)
+  let(:response_body) { [{ id: 'an-object' }, { id: 'another-object' }] }
+  it_should_behave_like "an action that makes a request to Onfleet", method: :get
+end
+
+RSpec.shared_examples_for Onfleet::Actions::Create do |path:|
+  set_up_request_stub(:post, path)
+  let(:response_body) { { id: 'an-object' } }
+
+  it_should_behave_like "an action that makes a request to Onfleet", method: :post
+
+  it "should send the object params, not including ID, in JSON" do
+    expected_params = camelize_keys(params.stringify_keys.except('id'))
+
+    subject.call
+    expect(
+      a_request(:post, url).with(body: expected_params.to_json)
+    ).to have_been_made.once
+  end
+end
+
+RSpec.shared_examples_for Onfleet::Actions::Update do |path:|
+  set_up_request_stub(:put, path)
+  let(:response_body) { { id: 'an-object' } }
+
+  it_should_behave_like "an action that makes a request to Onfleet", method: :put
+
+  # The current implementation -- using instance variables -- makes it impossible
+  # to have this example pass deterministically.
+  xit "should send the object params, including ID, in JSON" do
+    expected_params = camelize_keys(params.merge(id: id))
+
+    subject.call
+    expect(
+      a_request(:put, url).with(body: expected_params.to_json)
+    ).to have_been_made.once
+  end
+end
+
+RSpec.shared_examples_for Onfleet::Actions::Delete do |path:|
+  set_up_request_stub(:delete, path)
+  let(:response_body) { '' }
+
+  it_should_behave_like "an action that makes a request to Onfleet", method: :delete
+end
+
+RSpec.shared_examples_for Onfleet::Actions::Find do |path:|
+  set_up_request_stub(:get, path)
+  let(:response_body) { { id: 'an-object' } }
+  it_should_behave_like "an action that makes a request to Onfleet", method: :get
+end
+
+RSpec.shared_examples_for Onfleet::Actions::QueryMetadata do |path:|
+  set_up_request_stub(:post, path + '/metadata')
+  let(:response_body) { [{ id: 'an-object' }, { id: 'another-object' }] }
+  it_should_behave_like "an action that makes a request to Onfleet", method: :post
+
+  it "should send metadata in JSON" do
+    subject.call
+    expect(
+      a_request(:post, url).with(body: metadata.to_json)
+    ).to have_been_made.once
+  end
+end
+
+def set_up_request_stub(method, path)
+  let(:url) { URI.join(Onfleet.base_url, path).to_s }
+  let(:response) { { status: 200, body: response_body.to_json } }
+  before { stub_request(method, url).to_return(response) }
+end
+
+def camelize_keys(hash)
+  hash.inject({}) do |accumulator, (key, value)|
+    accumulator.merge(key.camelize(:lower) => value)
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfleet-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nick Wargnier
@@ -10,40 +10,104 @@ bindir: bin
 cert_chain: []
 date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
-    - - ">="
+        version: '0.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+- !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.0.0
+        version: '3.4'
 description: To interact with Onfleet's API
 email: nick@stylelend.com
 executables: []
@@ -52,8 +116,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
 - Gemfile
 - README.md
+- Rakefile
 - lib/onfleet-ruby.rb
 - lib/onfleet-ruby/actions/create.rb
 - lib/onfleet-ruby/actions/delete.rb
@@ -80,8 +148,16 @@ files:
 - lib/onfleet-ruby/webhook.rb
 - lib/onfleet-ruby/worker.rb
 - onfleet-ruby.gemspec
+- spec/onfleet/admin_spec.rb
+- spec/onfleet/destination_spec.rb
+- spec/onfleet/organization_spec.rb
+- spec/onfleet/recipient_spec.rb
+- spec/onfleet/task_spec.rb
+- spec/onfleet/team_spec.rb
+- spec/onfleet/webhook_spec.rb
+- spec/onfleet/worker_spec.rb
 - spec/spec_helper.rb
-- spec/test_data.rb
+- spec/support/http_requests/shared_examples.rb
 homepage: http://rubygems.org/gems/onfleet-ruby
 licenses:
 - MIT
@@ -102,10 +178,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Onfleet ruby api
 test_files:
+- spec/onfleet/admin_spec.rb
+- spec/onfleet/destination_spec.rb
+- spec/onfleet/organization_spec.rb
+- spec/onfleet/recipient_spec.rb
+- spec/onfleet/task_spec.rb
+- spec/onfleet/team_spec.rb
+- spec/onfleet/webhook_spec.rb
+- spec/onfleet/worker_spec.rb
 - spec/spec_helper.rb
-- spec/test_data.rb
+- spec/support/http_requests/shared_examples.rb

data/spec/test_data.rb

@@ -1,14 +0,0 @@
-module Onfleet
-  module TestData
-    def recipient
-
-    end
-
-    def destination
-
-    end
-
-    def task
-    end
-  end
-end