shipcloud 0.6.0 → 0.11.0

data/spec/shipcloud_spec.rb

@@ -16,74 +16,136 @@ describe Shipcloud do
 
       it "attempts to get a url with one param" do
         Shipcloud.request(:get, "transactions", { param_name: "param_value" })
-        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}/transactions?param_name=param_value")
+
+        expect(WebMock).to have_requested(:get, "#{api_url}/transactions?param_name=param_value")
       end
 
       it "attempts to get a url with more than one param" do
         Shipcloud.request(:get, "transactions", { client: "client_id", order: "created_at_desc" })
-        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}/transactions?client=client_id&order=created_at_desc")
+
+        expect(WebMock).
+          to have_requested(:get, "#{api_url}/transactions?client=client_id&order=created_at_desc")
       end
 
       it "doesn't add a question mark if no params" do
         Shipcloud.request(:get, "transactions", {})
-        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}/transactions")
+        expect(WebMock).to have_requested(:get, "#{api_url}/transactions")
+      end
+    end
+
+    context "with an api key passed in as an argument" do
+      it "uses the given api key instead of the global one" do
+        WebMock.stub_request(:any, /#{Shipcloud.configuration.api_base}/).to_return(body: "{}")
+        Shipcloud.api_key = "global-api-key"
+
+        Shipcloud.request(:get, "transactions", {}, api_key: "123")
+
+        expect(WebMock).to have_requested(
+          :get,
+          "#{api_url}/transactions",
+        ).with(
+          headers: {
+            "Authorization" => "Basic #{Base64.strict_encode64('123:').chomp}",
+          },
+        )
       end
     end
   end
 
-  describe '.configure' do
+  describe ".configure" do
     before :each do
       Shipcloud.configuration = nil
     end
 
-    it 'defaults api_key to nil' do
+    it "defaults api_key to nil" do
       expect(Shipcloud.configuration.api_key).to be_nil
     end
 
-    it 'sets the api_key' do
+    it "sets the api_key" do
       Shipcloud.configure do |config|
-        config.api_key = 'your-api-key'
+        config.api_key = "your-api-key"
       end
-      expect(Shipcloud.configuration.api_key).to eq 'your-api-key'
+      expect(Shipcloud.configuration.api_key).to eq "your-api-key"
     end
 
-    it 'gets the api key, set as a class variable (DEPRECATED)' do
-      Shipcloud.api_key = 'old-school-api-key'
-      expect(Shipcloud.api_key).to eq 'old-school-api-key'
-      expect(Shipcloud.configuration.api_key).to eq 'old-school-api-key'
+    it "gets the api key, set as a class variable (DEPRECATED)" do
+      Shipcloud.api_key = "old-school-api-key"
+      expect(Shipcloud.api_key).to eq "old-school-api-key"
+      expect(Shipcloud.configuration.api_key).to eq "old-school-api-key"
     end
 
     it "defaults api_base to 'api.shipcloud.io'" do
-      expect(Shipcloud.configuration.api_base).to eq 'api.shipcloud.io'
+      expect(Shipcloud.configuration.api_base).to eq "api.shipcloud.io"
     end
 
-    it 'overwrites the default api base' do
+    it "overwrites the default api base" do
       Shipcloud.configure do |config|
-        config.api_base = 'api.shipcloud.dev'
+        config.api_base = "api.shipcloud.dev"
       end
-      expect(Shipcloud.configuration.api_base).to eq 'api.shipcloud.dev'
+      expect(Shipcloud.configuration.api_base).to eq "api.shipcloud.dev"
     end
 
-    it 'defaults use_ssl to true' do
+    it "defaults use_ssl to true" do
       expect(Shipcloud.configuration.use_ssl).to be true
     end
 
-    it 'overwrites the default ssl mode' do
+    it "overwrites the default ssl mode" do
       Shipcloud.configure do |config|
         config.use_ssl = false
       end
       expect(Shipcloud.configuration.use_ssl).to be false
     end
 
-    it 'defaults debug to false' do
+    it "defaults debug to false" do
       expect(Shipcloud.configuration.debug).to be false
     end
 
-    it 'overwrites the default debug mode' do
+    it "overwrites the default debug mode" do
       Shipcloud.configure do |config|
         config.debug = true
       end
       expect(Shipcloud.configuration.debug).to be true
     end
+
+    it "defaults affiliate_id to nil" do
+      expect(Shipcloud.configuration.affiliate_id).to be_nil
+    end
+
+    it "sets and gets the affiliate_id" do
+      Shipcloud.configure do |config|
+        config.affiliate_id = "integration.my_rails_app.1234567"
+      end
+
+      expect(Shipcloud.configuration.affiliate_id).to eq "integration.my_rails_app.1234567"
+    end
+  end
+
+  describe ".api_headers" do
+    it "returns the correct api headers with default affiliate id" do
+      Shipcloud.configuration = nil # reset configuration
+
+      expect(Shipcloud.api_headers).to eq(
+        "Content-Type" => "application/json",
+        "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, " \
+          "#{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}",
+        "Affiliate-ID" => "integration.shipcloud-ruby-gem.v#{Shipcloud::VERSION}",
+      )
+    end
+
+    it "returns the correct api headers with affiliate id if configured" do
+      Shipcloud.configure do |config|
+        config.affiliate_id = "integration.my_rails_app.1234567"
+      end
+      expect(Shipcloud.api_headers).to eq(
+        "Content-Type" => "application/json",
+        "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, " \
+          "#{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}",
+        "Affiliate-ID" => "integration.my_rails_app.1234567",
+      )
+    end
+  end
+
+  def api_url
+    "https://#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}"
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+require "simplecov"
+SimpleCov.start
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: shipcloud
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - sthollmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2020-07-28 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'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
@@ -24,90 +21,81 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -120,10 +108,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A wrapper for the shipcloud API. Fore more details visit https://developers.shipcloud.io/
 email:
 - stefan@shipcloud.io
-executables: []
+executables:
+- rubocop
 extensions: []
 extra_rdoc_files: []
 files:
@@ -132,13 +135,15 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-style.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rubocop
+- install-cc-test-reporter.sh
 - lib/shipcloud.rb
 - lib/shipcloud/address.rb
 - lib/shipcloud/base.rb
@@ -148,22 +153,27 @@ files:
 - lib/shipcloud/operations/delete.rb
 - lib/shipcloud/operations/find.rb
 - lib/shipcloud/operations/update.rb
+- lib/shipcloud/pickup_request.rb
 - lib/shipcloud/request/base.rb
 - lib/shipcloud/request/connection.rb
 - lib/shipcloud/request/info.rb
-- lib/shipcloud/request/validator.rb
+- lib/shipcloud/shipcloud_error.rb
 - lib/shipcloud/shipment.rb
 - lib/shipcloud/shipment_quote.rb
+- lib/shipcloud/tracker.rb
 - lib/shipcloud/version.rb
 - lib/shipcloud/webhook.rb
 - shipcloud.gemspec
 - spec/shipcloud/address_spec.rb
 - spec/shipcloud/carrier_spec.rb
+- spec/shipcloud/pickup_request_spec.rb
 - spec/shipcloud/request/base_spec.rb
 - spec/shipcloud/request/connection_spec.rb
-- spec/shipcloud/request/validator_spec.rb
+- spec/shipcloud/request/info_spec.rb
+- spec/shipcloud/shipcloud_error_spec.rb
 - spec/shipcloud/shipment_quote_spec.rb
 - spec/shipcloud/shipment_spec.rb
+- spec/shipcloud/tracker_spec.rb
 - spec/shipcloud/webhooks_spec.rb
 - spec/shipcloud_spec.rb
 - spec/spec_helper.rb
@@ -171,7 +181,7 @@ homepage: https://github.com/shipcloud/shipcloud-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,26 +189,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A wrapper for the shipcloud API
 test_files:
 - spec/shipcloud/address_spec.rb
 - spec/shipcloud/carrier_spec.rb
+- spec/shipcloud/pickup_request_spec.rb
 - spec/shipcloud/request/base_spec.rb
 - spec/shipcloud/request/connection_spec.rb
-- spec/shipcloud/request/validator_spec.rb
+- spec/shipcloud/request/info_spec.rb
+- spec/shipcloud/shipcloud_error_spec.rb
 - spec/shipcloud/shipment_quote_spec.rb
 - spec/shipcloud/shipment_spec.rb
+- spec/shipcloud/tracker_spec.rb
 - spec/shipcloud/webhooks_spec.rb
 - spec/shipcloud_spec.rb
 - spec/spec_helper.rb

data/.ruby-style.yml

@@ -1,240 +0,0 @@
-AllCops:
-  RunRailsCops: true
-  Exclude:
-    - "vendor/**/*"
-    - "db/schema.rb"
-  UseCache: false
-Rails/FindBy:
-  Enabled: false
-Metrics/LineLength:
-  Max: 100
-Style/CollectionMethods:
-  Description: Preferred collection methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
-  Enabled: true
-  PreferredMethods:
-    collect: map
-    collect!: map!
-    find: detect
-    find_all: select
-    reduce: inject
-Style/DotPosition:
-  Description: Checks the position of the dot in multi-line method calls.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
-  Enabled: true
-  EnforcedStyle: trailing
-  SupportedStyles:
-  - trailing
-Style/FileName:
-  Description: Use snake_case for source file names.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
-  Enabled: false
-  Exclude: []
-Style/GuardClause:
-  Description: Check for conditionals that can be replaced with guard clauses
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
-  Enabled: false
-  MinBodyLength: 1
-Style/IfUnlessModifier:
-  Description: Favor modifier if/unless usage when you have a single-line body.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
-  Enabled: false
-  MaxLineLength: 80
-Style/OptionHash:
-  Description: Don't use option hashes when you can use keyword arguments.
-  Enabled: false
-Style/PercentLiteralDelimiters:
-  Description: Use `%`-literal delimiters consistently
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
-  Enabled: false
-  PreferredDelimiters:
-    "%": "()"
-    "%i": "()"
-    "%q": "()"
-    "%Q": "()"
-    "%r": "{}"
-    "%s": "()"
-    "%w": "()"
-    "%W": "()"
-    "%x": "()"
-Style/PredicateName:
-  Description: Check the names of predicate methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
-  Enabled: true
-  NamePrefix:
-  - is_
-  - has_
-  - have_
-  NamePrefixBlacklist:
-  - is_
-  Exclude:
-  - spec/**/*
-Style/RaiseArgs:
-  Description: Checks the arguments passed to raise/fail.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
-  Enabled: false
-  EnforcedStyle: exploded
-  SupportedStyles:
-  - compact
-  - exploded
-Style/SignalException:
-  Description: Checks for proper usage of fail and raise.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
-  Enabled: false
-  EnforcedStyle: semantic
-  SupportedStyles:
-  - only_raise
-  - only_fail
-  - semantic
-Style/SingleLineBlockParams:
-  Description: Enforces the names of some block params.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
-  Enabled: false
-  Methods:
-  - reduce:
-    - a
-    - e
-  - inject:
-    - a
-    - e
-Style/SingleLineMethods:
-  Description: Avoid single-line methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
-  Enabled: false
-  AllowIfMethodIsEmpty: true
-Style/StringLiterals:
-  Description: Checks if uses of quotes match the configured preference.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
-  Enabled: true
-  EnforcedStyle: double_quotes
-  SupportedStyles:
-  - single_quotes
-  - double_quotes
-Style/StringLiteralsInInterpolation:
-  Description: Checks if uses of quotes inside expressions in interpolated strings
-    match the configured preference.
-  Enabled: true
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-  - single_quotes
-  - double_quotes
-Style/TrailingComma:
-  Description: Checks for trailing comma in parameter lists and literals.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
-  Enabled: false
-  EnforcedStyleForMultiline: no_comma
-  SupportedStyles:
-  - comma
-Metrics/AbcSize:
-  Description: A calculated magnitude based on number of assignments, branches, and
-    conditions.
-  Enabled: false
-  Max: 15
-Metrics/ClassLength:
-  Description: Avoid classes longer than 100 lines of code.
-  Enabled: false
-  CountComments: false
-  Max: 100
-Metrics/ModuleLength:
-  CountComments: false
-  Max: 100
-  Description: Avoid modules longer than 100 lines of code.
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Description: A complexity metric that is strongly correlated to the number of test
-    cases needed to validate a method.
-  Enabled: false
-  Max: 6
-Metrics/MethodLength:
-  Description: Avoid methods longer than 10 lines of code.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
-  Enabled: false
-  CountComments: false
-  Max: 10
-Metrics/ParameterLists:
-  Description: Avoid parameter lists longer than three or four parameters.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
-  Enabled: false
-  Max: 5
-  CountKeywordArgs: true
-Metrics/PerceivedComplexity:
-  Description: A complexity metric geared towards measuring complexity for a human
-    reader.
-  Enabled: false
-  Max: 7
-Lint/AssignmentInCondition:
-  Description: Don't use assignment in conditions.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
-  Enabled: false
-  AllowSafeAssignment: true
-Style/InlineComment:
-  Description: Avoid inline comments.
-  Enabled: false
-Style/AccessorMethodName:
-  Description: Check the naming of accessor methods for get_/set_.
-  Enabled: false
-Style/Alias:
-  Description: Use alias_method instead of alias.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
-  Enabled: false
-Style/Documentation:
-  Description: Document classes and non-namespace modules.
-  Enabled: false
-Style/DoubleNegation:
-  Description: Checks for uses of double negation (!!).
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
-  Enabled: false
-Style/EachWithObject:
-  Description: Prefer `each_with_object` over `inject` or `reduce`.
-  Enabled: false
-Style/EmptyLiteral:
-  Description: Prefer literals to Array.new/Hash.new/String.new.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
-  Enabled: false
-Style/ModuleFunction:
-  Description: Checks for usage of `extend self` in modules.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
-  Enabled: false
-Style/OneLineConditional:
-  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
-  Enabled: false
-Style/PerlBackrefs:
-  Description: Avoid Perl-style regex back references.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
-  Enabled: false
-Style/Send:
-  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
-    may overlap with existing methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
-  Enabled: false
-Style/SpecialGlobalVars:
-  Description: Avoid Perl-style global variables.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
-  Enabled: false
-Style/VariableInterpolation:
-  Description: Don't interpolate global, instance and class variables directly in
-    strings.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
-  Enabled: false
-Style/WhenThen:
-  Description: Use when x then ... for one-line cases.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
-  Enabled: false
-Lint/EachWithObjectArgument:
-  Description: Check for immutable argument given to each_with_object.
-  Enabled: true
-Lint/EndAlignment:
-  Description: This cop checks whether the end keywords are aligned properly.
-  AlignWith: variable
-  Enabled: true
-Lint/HandleExceptions:
-  Description: Don't suppress exception.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
-  Enabled: false
-Lint/LiteralInCondition:
-  Description: Checks of literals used in conditions.
-  Enabled: false
-Lint/LiteralInInterpolation:
-  Description: Checks for literals used in interpolation.
-  Enabled: false