shipping_easy 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebd04dbdd41ee01468d230b49d8a09d96b1b710f
-  data.tar.gz: f5e968ca055a2b3d815256a9b29bfa2512f2ff0e
+  metadata.gz: 5c62015eb66f896c021b5f30a2ba96f89dbc86cd
+  data.tar.gz: def4083bb09525e7b70b41273a04e34839870941
 SHA512:
-  metadata.gz: b18d15c901061061fe5c098cefb0124abf42b92f551110887a5282336cd0330bcfec3b2ba0a1a82457ec3b020a858342727771163dd3ac50772ec3e0d25fc0e1
-  data.tar.gz: 7a59cec9864af8dc7e3fd70bb49898960574839acf00e78efaa780f37d5479f8caadf8b8f3f6e4d1a8505418596a627b4f28c971561ebe3cf217d0a8204bfe82
+  metadata.gz: 73254bc040b76b38f58f8579753674dddfc62b7a5e862a6e9c2dee25d699c097fd6a8ff23c82e300cde572a64a4c4e5631499a79eab2a60974658c6878f12207
+  data.tar.gz: a4a5a5c5f57a7a0642f143b9bb392534878d5546f3f8930794078941f2550116054be20f72230e25d96fc54238ebf280558baf98219d75beaf80eea7bc4c25dd

data/lib/shipping_easy/configuration.rb

@@ -13,19 +13,30 @@
 #
 module ShippingEasy
   class Configuration
+    LEGACY_URL = "https://app.shippingeasy.com"
+    DEFAULT_URL = "https://api.shippingeasy.com"
 
+    attr_reader   :base_url
     attr_accessor :api_key,
                   :api_secret,
                   :partner_api_key,
                   :partner_api_secret,
                   :api_version,
-                  :base_url,
                   :http_adapter
 
     # Creates a configuration object, setting the default attributes.
     def initialize
       @http_adapter = ShippingEasy::Http::FaradayAdapter
-      @base_url = "https://app.shippingeasy.com"
+      @base_url = DEFAULT_URL
+    end
+
+    def base_url=(val)
+      if val == LEGACY_URL
+        warn "Legacy URL detected, updating to api.shippingeasy.com"
+        @base_url = DEFAULT_URL
+      else
+        @base_url = val
+      end
     end
   end
 end

data/lib/shipping_easy/http/faraday_adapter.rb

@@ -1,3 +1,4 @@
+require 'faraday_middleware'
 class ShippingEasy::Http::FaradayAdapter
 
   extend Forwardable
@@ -30,8 +31,21 @@ class ShippingEasy::Http::FaradayAdapter
 
   def connection
     @connection ||= Faraday.new(url: base_url) do |faraday|
+      faraday.use FaradayMiddleware::FollowRedirects, limit: 3, standards_compliant: true
+      faraday.use CustomUserAgent, "shipping_easy-ruby/#{ShippingEasy::VERSION}"
       faraday.adapter Faraday.default_adapter
     end
   end
+  
+  class CustomUserAgent < Faraday::Middleware
+    def initialize(app, agent_string)
+      super(app)
+      @agent_string = agent_string
+    end
 
+    def call(env)
+      env[:request_headers]['User-Agent'] = @agent_string
+      @app.call(env)
+    end
+  end
 end

data/lib/shipping_easy/http/request.rb

@@ -5,7 +5,7 @@ class ShippingEasy::Http::Request
   def initialize(options = {})
     @http_method = options.fetch(:http_method, :get)
     @params = options.fetch(:params, {})
-    @body = options.fetch(:payload, {}).to_json
+    @body = options[:payload] && options[:payload].to_json
     @relative_path = options.delete(:relative_path)
   end
 

data/lib/shipping_easy/version.rb

@@ -1,3 +1,3 @@
 module ShippingEasy
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/shipping_easy.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency('faraday', '>= 0.8.7')
+  spec.add_dependency('faraday_middleware', '>= 0.9.2')
   spec.add_dependency('rack', ">= 1.4.5")
   spec.add_dependency('json', "~> 1.8.0")
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "rake"
 end

data/spec/configuration_spec.rb

@@ -20,12 +20,17 @@ describe ShippingEasy::Configuration do
 
   describe "base_url" do
     it "gets set to a default" do
-      subject.base_url.should == "https://app.shippingeasy.com"
+      subject.base_url.should == "https://api.shippingeasy.com"
     end
 
     it "can be overidden" do
       subject.base_url = String
       subject.base_url.should == String
     end
+
+    it "ignores if set to the legacy URL" do
+      subject.base_url = "https://app.shippingeasy.com"
+      subject.base_url.should == "https://api.shippingeasy.com"
+    end
   end
 end

data/spec/http/faraday_adapter_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require 'webmock/rspec'
 
 describe ShippingEasy::Http::FaradayAdapter do
 
@@ -39,4 +40,21 @@ describe ShippingEasy::Http::FaradayAdapter do
     end
   end
 
+  it "redirects, preserving method" do
+    stub_request(:post, "https://app.shippingeasy.com").to_return(
+      :status => 307,
+      :headers => {  "Location" => "https://app1.shippingeasy.com/" })
+    stub_request(:post, "https://app1.shippingeasy.com/")
+
+    response = subject.connection.post("https://app.shippingeasy.com")
+
+    expect(response.env[:method]).to eq(:post)
+    expect(response.env[:url].to_s).to eq("https://app1.shippingeasy.com/")
+  end
+
+  it "adds a custom user agent" do
+    stub_request(:post, "https://app.shippingeasy.com")
+    response = subject.connection.post("https://app.shippingeasy.com")
+    expect(response.env.request_headers["User-Agent"]).to eq("shipping_easy-ruby/#{ShippingEasy::VERSION}")
+  end
 end

data/spec/http/request_spec.rb

@@ -9,7 +9,8 @@ describe ShippingEasy::Http::Request do
   let(:body) { { order_number: "1234" } }
   let(:api_key) { "12345678ASGHSGHJ" }
   let(:api_secret) { "12345678ASGHSGHJ123213321312" }
-  let(:signature) { ShippingEasy::Signature.new(api_secret: api_secret, method: http_method, path: "/api#{relative_path}", params: params.dup, body: body.to_json) }
+  let(:signed_body) { body && body.to_json }
+  let(:signature) { ShippingEasy::Signature.new(api_secret: api_secret, method: http_method, path: "/api#{relative_path}", params: params.dup, body: signed_body) }
 
   before do
     ShippingEasy.configure do |config|
@@ -50,6 +51,25 @@ describe ShippingEasy::Http::Request do
     end
   end
 
+  describe 'body is nil for GET requests with nil body' do
+    let(:http_method) { "get" }
+    let(:body) { nil }
+    specify do
+      subject.body.should == nil
+      subject.signature.to_s.should == signature.to_s
+    end
+  end
+
+  describe 'body is nil for GET requests with omitted payload key' do
+    let(:http_method) { "get" }
+    let(:body) { nil }
+    subject { ShippingEasy::Http::Request.new(http_method: http_method, params: params, relative_path: relative_path) }
+    specify do
+      subject.body.should == nil
+      subject.signature.to_s.should == signature.to_s
+    end
+  end
+
   describe "#sign_request!" do
     before { subject.sign_request! }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipping_easy
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rake
   requirement: !ruby/object:Gem::Requirement