mad_cart 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f1f057e22f04e430441709ffc543c76e96374e
-  data.tar.gz: 17922368b33cf7c9b6d94ec522e90acf520fbb95
+  metadata.gz: 3ecdd2f48e981f110c690f70ab25a4beeb069391
+  data.tar.gz: 36ce1a0fa9c93679bf16a4622ca2ddf7b2e8c99e
 SHA512:
-  metadata.gz: 24c11629ff7a2d6cb6f75dfef75ce80b7ca434ffdb9d35a6b872f272d479144459d53230098a4215826f60cc85260bdc4c46175f989996ae1be196a2c8107a65
-  data.tar.gz: 00119daa25d5acb85c5ec6a5079e07c2910bff615ebe3d14cb5dfc3d9c2b477959134722fe918b330cc590bc86669dedef0d2ed2b63a70469527518487edfcb9
+  metadata.gz: a1b7a5593c7080e3b411292a8b19bdc6764ba239ec92d9e280b972df679b521ac85648c2350caa8a19fd534c97e8742faf04f2122a021eb73018279d521d2d94
+  data.tar.gz: f02165a862e4312a9f3b3b48d4bd66d6e0d659a6f7656b135ce7e94e8b5f6767af75f83b02ed8d0cbfab34ebf1ad85c2ec7eee954812955515b7cd346cbb7d2b

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.1.2 (7 June 2016)
+
+Features:
+
+  - New `MadCart::Store::UnavailableStore` error raised when there is a (possibly) temporary problem with the connection to the Store's API.
+
+Refactor:
+
+  - Removed duplication between the different stores in terms of how responses and connections are handled.
+
+## 0.1.1
+
+Initial release

data/README.md

@@ -114,7 +114,8 @@ MadCart throws several types of exceptions:
 ```ruby
 MadCart::Store::ServerError        #=> when Store's API returns server error response (status code: 500).
 MadCart::Store::InvalidCredentials #=> when Store's API returns unauthorized response (status code: 401).
-MadCart::Store::InvalidStore       #=> when there is a problem with connection to Store's API.
+MadCart::Store::InvalidStore       #=> when there is a problem reaching the Store's API.
+MadCart::Store::UnavailableStore   #=> when there is a possibly temporary problem with the connection to the Store's API.
 ```
 
 ## Contributing

data/lib/mad_cart/store/base.rb

@@ -13,6 +13,7 @@ module MadCart
     InvalidStore       = Class.new(StandardError)
     ServerError        = Class.new(StandardError)
     InvalidCredentials = Class.new(StandardError)
+    UnavailableStore   = Class.new(StandardError)
 
     module Base
       DEFAULT_CONNECTION_OPTIONS = {
@@ -42,6 +43,43 @@ module MadCart
         @connection ||= execute_delegate(klass.connection_delegate, @init_args)
       end
 
+      def valid_by_path?(path)
+        check_for_errors do
+          connection.get(path)
+        end
+        true
+      rescue InvalidCredentials, InvalidStore, ServerError, UnavailableStore
+        false
+      end
+      private :valid_by_path?
+
+      def parse_response(&block)
+        response = check_for_errors &block
+        empty_body?(response) ? [] : response.body
+      end
+      private :parse_response
+
+      def check_for_errors(&block)
+        response = yield
+
+        case response.status
+        when 401
+          raise InvalidCredentials
+        when 500
+          raise ServerError
+        end
+
+        response
+      rescue Faraday::Error::ConnectionFailed, Faraday::ParsingError, Faraday::SSLError
+        raise UnavailableStore
+      end
+      private :check_for_errors
+
+      def empty_body?(response)
+        response.status == 204 || response.body.nil?
+      end
+      private :empty_body?
+
       def klass
         self.class
       end

data/lib/mad_cart/store/big_commerce.rb

@@ -9,13 +9,7 @@ module MadCart
       fetch :store, :with => :get_store
 
       def valid?
-        check_for_errors do
-          connection.get('time.json')
-        end
-        return true
-
-      rescue InvalidCredentials => e
-        return false
+        valid_by_path?('time.json')
       end
 
       def products_count
@@ -59,7 +53,7 @@ module MadCart
       def get_customer_hashes
         result = []
         loop(:make_customer_request) {|c| result << c }
-        return result
+        result
       end
 
       def loop(source, &block)
@@ -78,35 +72,10 @@ module MadCart
         parse_response { connection.get('store.json') }
       end
 
-      def parse_response(&block)
-        response = check_for_errors &block
-        return [] if empty_body?(response)
-        return response.body
-      end
-
-      def check_for_errors(&block)
-        response = yield
-
-        case response.status
-        when 401
-          raise InvalidCredentials
-        when 500
-          raise ServerError
-        end
-
-        response
-      rescue Faraday::Error::ConnectionFailed => e
-        raise InvalidStore
-      end
-
       def api_url_for(store_domain)
        "https://#{store_domain}/api/v2/"
       end
 
-      def empty_body?(response)
-        true if response.status == 204 || response.body.nil?
-      end
-
       def create_connection(args={})
         Faraday.new(DEFAULT_CONNECTION_OPTIONS.merge(:url => api_url_for(args[:store_url]))) do |connection|
           connection.basic_auth(args[:username], args[:api_key])

data/lib/mad_cart/store/spree.rb

@@ -11,12 +11,7 @@ module MadCart
       fetch :products, :with => :get_products
 
       def valid?
-        check_for_errors do
-          connection.get('orders.json')
-        end
-        return true
-      rescue InvalidCredentials => e
-        return false
+        valid_by_path?('orders.json')
       end
 
       def products_count
@@ -101,35 +96,10 @@ module MadCart
         items.each(&block)
       end
 
-      def parse_response(&block)
-        response = check_for_errors &block
-        return [] if empty_body?(response)
-        return response.body
-      end
-
-      def check_for_errors(&block)
-        response = yield
-
-        case response.status
-        when 401
-          raise InvalidCredentials
-        when 500
-          raise ServerError
-        end
-
-        response
-      rescue Faraday::Error::ConnectionFailed => e
-        raise InvalidStore
-      end
-
       def api_url_for(store_domain)
        "http://#{store_domain}/api/"
       end
 
-      def empty_body?(response)
-        true if response.status == 204 || response.body.nil?
-      end
-
       def create_connection(args={})
         Faraday.new(DEFAULT_CONNECTION_OPTIONS.merge(:url => api_url_for(args[:store_url]))) do |connection|
           connection.response :json

data/lib/mad_cart/version.rb

@@ -1,3 +1,3 @@
 module MadCart
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/fixtures/vcr_cassettes/big_commerce_server_error.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://support%40madmimi.com:an-invalid-key@store-cr4wsh4.mybigcommerce.com/api/v2/time.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 31 May 2016 10:09:21 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - fornax_anonymousId=1bc2ddc4-69b4-43ec-a7e7-6fca029c0eea; expires=Sun, 27-Nov-2016
+        10:09:21 GMT; path=/; domain=.store-cr4wsh4.mybigcommerce.com
+      Www-Authenticate:
+      - Basic
+      X-Bc-Store-Version:
+      - 7.6.0
+    body:
+      encoding: UTF-8
+      string: '[{"status":401,"message":"The specified credentials were invalid."}]'
+    http_version: 
+  recorded_at: Tue, 31 May 2016 10:09:23 GMT
+recorded_with: VCR 2.5.0

data/spec/lib/store/big_commerce_spec.rb

@@ -123,6 +123,24 @@ describe MadCart::Store::BigCommerce do
       end
     end
 
+    it "fails if it cannot connect to the big commerce server" do
+      VCR.use_cassette('big_commerce_server_error') do
+        api = MadCart::Store::BigCommerce.new(
+          :api_key => 'an-invalid-key',
+          :store_url => 'store-cr4wsh4.mybigcommerce.com',
+          :username => 'support@madmimi.com'
+        )
+
+        api.should_not be_valid
+      end
+    end
+
+    it "fails if it cannot parse the response from the big commerce server" do
+      VCR.use_cassette('big_commerce_time') do
+        subject.connection.stub(:get) { raise Faraday::ParsingError, "" }
+        subject.should_not be_valid
+      end
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mad_cart
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Marc Heiligers
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -203,6 +203,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -228,6 +229,7 @@ files:
 - spec/fixtures/vcr_cassettes/big_commerce_products.yml
 - spec/fixtures/vcr_cassettes/big_commerce_products_count.yml
 - spec/fixtures/vcr_cassettes/big_commerce_products_no_images.yml
+- spec/fixtures/vcr_cassettes/big_commerce_server_error.yml
 - spec/fixtures/vcr_cassettes/big_commerce_store.yml
 - spec/fixtures/vcr_cassettes/big_commerce_time.yml
 - spec/fixtures/vcr_cassettes/etsy_store_does_not_exist.yml
@@ -268,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Allows communication with various e-commerce merchants such as BigCommerce
@@ -281,6 +283,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/big_commerce_products.yml
 - spec/fixtures/vcr_cassettes/big_commerce_products_count.yml
 - spec/fixtures/vcr_cassettes/big_commerce_products_no_images.yml
+- spec/fixtures/vcr_cassettes/big_commerce_server_error.yml
 - spec/fixtures/vcr_cassettes/big_commerce_store.yml
 - spec/fixtures/vcr_cassettes/big_commerce_time.yml
 - spec/fixtures/vcr_cassettes/etsy_store_does_not_exist.yml