shipcloud 0.7.0 → 0.8.0

data/spec/shipcloud/tracker_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe Shipcloud::PickupRequest do
+  valid_attributes = {
+    carrier: "ups",
+    carrier_tracking_no: "723558934169",
+  }
+
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
+      tracker = Shipcloud::Tracker.new(valid_attributes)
+
+      expect(tracker.carrier).to eq "ups"
+      expect(tracker.carrier_tracking_no).to eq "723558934169"
+    end
+  end
+
+  describe ".all" do
+    it "makes a new GET request using the correct API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers", {}, api_key: nil).
+        and_return("trackers" => [])
+
+      Shipcloud::Tracker.all
+    end
+
+    it "returns a list of Tracker objects" do
+      stub_trackers_requests
+
+      trackers = Shipcloud::Tracker.all
+
+      trackers.each do |tracker|
+        expect(tracker).to be_a Shipcloud::Tracker
+      end
+    end
+  end
+
+  describe ".create" do
+    it "makes a new POST request using the correct API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "trackers", valid_attributes, api_key: nil).
+        and_return("data" => {})
+
+      Shipcloud::Tracker.create(valid_attributes)
+    end
+  end
+
+  describe ".find" do
+    it "makes a new GET request using the correct API endpoint to receive a specific tracker" do
+      expect(Shipcloud).to receive(:request).with(:get, "trackers/123", {}, api_key: nil).
+        and_return("id" => "123")
+
+      Shipcloud::Tracker.find("123")
+    end
+  end
+
+  def stub_trackers_requests
+    allow(Shipcloud).to receive(:request).
+      with(:get, "trackers", {}, api_key: nil).
+      and_return("trackers" => trackers_array)
+  end
+
+  def trackers_array
+    [
+      {
+        "id" => "4a6922e2-09ad-4724-807c-7b4e572d3c6b",
+        "carrier_tracking_no" => "723558934169",
+        "status" => "registered",
+        "created_at" => "2015-07-21T09:35:23+02:00",
+        "to" => {
+          "company" => nil,
+          "first_name" => "Hans",
+          "last_name" => "Meier",
+          "care_of" => nil,
+          "street" => "Semmelweg",
+          "street_no" => "1",
+          "zip_code" => "12345",
+          "city" => "Hamburg",
+          "state" => nil,
+          "country" => "DE",
+        },
+        "tracking_status_updated_at" => nil,
+        "last_polling_at" => nil,
+        "next_polling_at" => "2015-07-21T09:35:23+02:00",
+        "shipment_id" => "123456",
+        "carrier" => "ups",
+        "tracking_events" => [],
+      },
+      {
+        "id" => "7b4e572d3c6b-4a6922e2-09ad-4724-807c",
+        "carrier_tracking_no" => "723558934170",
+        "status" => "registered",
+        "created_at" => "2015-07-20T09:35:23+02:00",
+        "to" => {
+          "company" => nil,
+          "first_name" => "Rita",
+          "last_name" => "Rose",
+          "care_of" => nil,
+          "street" => "Geranienweg",
+          "street_no" => "2",
+          "zip_code" => "23456",
+          "city" => "Berlin",
+          "state" => nil,
+          "country" => "DE",
+        },
+        "tracking_status_updated_at" => nil,
+        "last_polling_at" => nil,
+        "next_polling_at" => "2015-07-21T09:35:23+02:00",
+        "shipment_id" => "654321",
+        "carrier" => "dpd",
+        "tracking_events" => [],
+      },
+    ]
+  end
+end

data/spec/shipcloud/webhooks_spec.rb

@@ -52,6 +52,37 @@ describe Shipcloud::Webhook do
     end
   end
 
+  describe ".delete" do
+    it "makes a DELETE request using the correct API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "webhooks/123", {}, api_key: nil).
+        and_return(true)
+      Shipcloud::Webhook.delete("123")
+    end
+  end
+
+  describe ".deactivated" do
+    let(:id) { "123" }
+
+    subject { Shipcloud::Webhook.find(id).deactivated }
+
+    before do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks/#{id}", {}, api_key: nil).
+        and_return("id" => id, "deactivated" => deactivated)
+    end
+
+    context "when the webhook is deactivated" do
+      let(:deactivated) { true }
+      it { is_expected.to be true }
+    end
+
+    context "when the webhook is not deactivated" do
+      let(:deactivated) { false }
+      it { is_expected.to be false }
+    end
+  end
+
   def stub_webhooks_request
     allow(Shipcloud).to receive(:request).
       with(:get, "webhooks", {}, api_key: nil).

data/spec/shipcloud_spec.rb

@@ -99,5 +99,43 @@ describe Shipcloud do
       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
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipcloud
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - sthollmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2017-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -132,7 +132,6 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-style.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -148,22 +147,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/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/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
@@ -187,18 +191,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 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/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,267 +0,0 @@
-AllCops:
-  Exclude:
-    - "vendor/**/*"
-    - "db/schema.rb"
-  UseCache: false
-Rails:
-  Enabled: true
-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/FirstArrayElementLineBreak:
-  Description: >-
-                 Checks for a line break before the first element in a
-                 multi-line array.
-  Enabled: true
-Style/FirstHashElementLineBreak:
-  Description: >-
-                 Checks for a line break before the first element in a
-                 multi-line hash.
-  Enabled: true
-Style/FirstMethodArgumentLineBreak:
-  Description: >-
-                 Checks for a line break before the first argument in a
-                 multi-line method call.
-  Enabled: true
-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/TrailingCommaInArguments:
-  Description: 'Checks for trailing comma in argument lists.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
-  Enabled: false
-  EnforcedStyleForMultiline: no_comma
-  SupportedStyles:
-  - comma
-  - consistent_comma
-  - no_comma
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
-  Enabled: false
-  EnforcedStyleForMultiline: no_comma
-  SupportedStyles:
-  - comma
-  - consistent_comma
-  - no_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