action_kit_rest 0.4.4 → 0.4.8

data/lib/action_kit_rest/response/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A class responsible for proxing to faraday response &
 # or a pagination collection.
 module ActionKitRest
@@ -5,9 +7,7 @@ module ActionKitRest
     class Collection
       include Enumerable
 
-      attr_reader :meta
-      attr_reader :objects
-
+      attr_reader :meta, :objects
 
       def initialize(meta, objects)
         @meta = meta
@@ -15,7 +15,7 @@ module ActionKitRest
       end
 
       def each(&block)
-        # todo handle pagination somehow!
+        # TODO: handle pagination somehow!
         objects.each do |o|
           block.call(o)
         end

data/lib/action_kit_rest/response/raise_error.rb

@@ -1,43 +1,46 @@
+# frozen_string_literal: true
+
 module ActionKitRest
   module Response
     class RaiseError < Faraday::Response::Middleware
-
       def on_complete(response)
         status_code = response[:status].to_i
         if (400...600).include? status_code
           if status_code == 400
             response_body = response[:body]
-            if JSON.parse(response_body)['errors'] == {'mailing_id' => ['Unable to associate this mailing ID with account.']}
+            if ActionKitRest::Response::InvalidAkidError.matches?(JSON.parse(response_body)['errors'])
               raise ActionKitRest::Response::InvalidAkidError.new(url: response[:url].to_s, body: response_body)
             else
               raise ActionKitRest::Response::ValidationError.new(url: response[:url].to_s, body: response_body)
             end
           elsif status_code == 404
-            raise ActionKitRest::Response::NotFound.new(response[:url].to_s)
+            raise ActionKitRest::Response::NotFound, response[:url].to_s
           elsif status_code == 401
-            raise ActionKitRest::Response::Unauthorized.new(response[:url].to_s)
-          elsif status_code == 500 && response[:body] =~ /\"error\"/
+            raise ActionKitRest::Response::Unauthorized, response[:url].to_s
+          elsif status_code == 500 && response[:body] =~ /"error"/
             error_hsh = JSON.parse(response[:body])
             error_message = error_hsh['error']
 
             if error_message == 'Sorry, this request could not be processed. Please try again later.'
-              raise ActionKitRest::Response::TryAgainLater.new(error_message(response))
+              raise ActionKitRest::Response::TryAgainLater, error_message(response)
             else
-              raise StandardError.new(error_message(response))
+              raise StandardError, error_message(response)
             end
           else
-            raise StandardError.new(error_message(response))
+            raise StandardError, error_message(response)
           end
         end
       end
 
       def error_message(response)
-        "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} \n\n #{response[:body] if response[:body]}"
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]} \n\n #{response[:body]}"
       end
     end
 
-    class TryAgainLater < StandardError ; end
-    class NotFound < StandardError ; end
-    class Unauthorized < StandardError ; end
+    class TryAgainLater < StandardError; end
+
+    class NotFound < StandardError; end
+
+    class Unauthorized < StandardError; end
   end
 end

data/lib/action_kit_rest/response/validation_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionKitRest
   module Response
     class ValidationError < StandardError
@@ -5,24 +7,33 @@ module ActionKitRest
 
       def initialize(params)
         self.url = params[:url]
-        self.body = params[:body]
+        self.body = params[:body].dup
         self.errors = JSON.parse(params[:body])['errors']
         super()
       end
 
       def to_s
-        begin
-          "#{super()} \n url: #{url} \n body: #{body} \n errors: #{errors}"
-        rescue Encoding::CompatibilityError
-          # Something went gravely wrong trying to construct the error message, so give up on the extra info
-          # and just raise the name of the exception.
-          # This will let us at least raise with a backtrace.
-          super
-        end
+        "#{super()} \n url: #{url} \n body: #{body.force_encoding('UTF-8')} \n errors: #{errors}"
+      rescue Encoding::CompatibilityError
+        # Something went gravely wrong trying to construct the error message, so give up on the extra info
+        # and just raise the name of the exception.
+        # This will let us at least raise with a backtrace.
+        super
       end
     end
 
     class InvalidAkidError < ValidationError
+      MATCHING_ERRORS = ['Unable to associate this mailing ID with account.',
+                         'לא הצלחנו לקשר בין מספר הזיהוי של רשימת הדיוור הזו לבין החשבון.'].freeze
+
+      def self.matches?(errors)
+        return false unless errors&.keys == ['mailing_id']
+
+        mailing_id_errors = errors['mailing_id']
+        return false unless mailing_id_errors.size == 1
+
+        MATCHING_ERRORS.include?(mailing_id_errors.first)
+      end
     end
   end
 end

data/lib/action_kit_rest/response/wrapper.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module ActionKitRest
   module Response
     class Wrapper
       include Enumerable
       extend Forwardable
 
-      attr_reader :response
-      attr_reader :kind
-      attr_reader :obj
+      attr_reader :response, :kind, :obj
 
       def_delegators :body, :empty?, :size, :include?, :length, :to_a, :first, :flatten, :include?, :keys, :[]
 
       def initialize(response)
-        @response    = response
+        @response = response
 
         if response.body.respond_to?(:meta) && response.body.meta
           @kind = :collection
@@ -42,7 +42,7 @@ module ActionKitRest
 
       # Response raw body
       def body
-        @body ? @body : response.body
+        @body || response.body
       end
 
       # Response status
@@ -70,10 +70,10 @@ module ActionKitRest
       # Convert any key to string before calling.
       #
       def [](key)
-        if self.body.is_a?(Array)
-          self.body[key]
+        if body.is_a?(Array)
+          body[key]
         else
-          self.body.send(:"#{key}")
+          body.send(:"#{key}")
         end
       end
 
@@ -112,9 +112,9 @@ module ActionKitRest
             block.call(o)
           end
         else
-          raise("can only iterate over collections")
+          raise('can only iterate over collections')
         end
       end
     end
   end
-end
+end

data/lib/action_kit_rest/tag.rb

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 module ActionKitRest
   class Tag < Base
     def base_path
       'tag'
     end
-    
+
     def find(name)
       response = list(name: name)
       response.obj.first
     end
-    
+
     def find_or_create(name)
       tag = find(name)
-      if tag.blank?
-        tag = create(name: name)
-      end
+      tag = create(name: name) if tag.blank?
       tag
     end
   end
-end
+end

data/lib/action_kit_rest/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionKitRest
   class User < Base
     def base_path
@@ -17,4 +19,4 @@ module ActionKitRest
       user
     end
   end
-end
+end

data/lib/action_kit_rest/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module ActionKitRest
   module VERSION
     MAJOR = 0
     MINOR = 4
-    PATCH = 4
+    PATCH = 8
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/action_kit_rest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vertebrae'
 
 module ActionKitRest

data/spec/lib/action_kit_rest/actions/event_create_action_spec.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActionKitRest::Actions::EventCreateAction do
   describe '#get' do
-    let(:actionkit) { ActionKitRest.new(host: 'test.com')  }
+    let(:actionkit) { ActionKitRest.new(host: 'test.com') }
 
     before :each do
-      stub_request(:get, "https://test.com/rest/v1/eventcreateaction/123/")
-        .to_return(body: fixture('action/event_create_action.json'), status: '200', headers: {content_type: "application/json; charset=utf-8"})
+      stub_request(:get, 'https://test.com/rest/v1/eventcreateaction/123/')
+        .to_return(body: fixture('action/event_create_action.json'), status: '200', headers: { content_type: 'application/json; charset=utf-8' })
     end
 
     it 'should retrieve eventcreateaction and aggregate parsed event and user IDs' do
       ak_event_create_action = actionkit.event_create_action.get('123')
 
-      expect(ak_event_create_action.id).to eq(12345)
+      expect(ak_event_create_action.id).to eq(12_345)
       expect(ak_event_create_action.event_id).to eq('999')
       expect(ak_event_create_action.user_id).to eq('112233')
     end

data/spec/lib/action_kit_rest/actions/event_signup_action_spec.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActionKitRest::Actions::EventSignupAction do
   describe '#get' do
-    let(:actionkit) { ActionKitRest.new(host: 'test.com')  }
+    let(:actionkit) { ActionKitRest.new(host: 'test.com') }
 
     before :each do
-      stub_request(:get, "https://test.com/rest/v1/eventsignupaction/54321/")
-        .to_return(body: fixture('action/event_signup_action.json'), status: '200', headers: {content_type: "application/json; charset=utf-8"})
+      stub_request(:get, 'https://test.com/rest/v1/eventsignupaction/54321/')
+        .to_return(body: fixture('action/event_signup_action.json'), status: '200', headers: { content_type: 'application/json; charset=utf-8' })
     end
 
     it 'should retrieve eventsignupaction and aggregate parsed event sign-up and user IDs' do
       ak_event_signup_action = actionkit.event_signup_action.get('54321')
 
-      expect(ak_event_signup_action.id).to eq(54321)
+      expect(ak_event_signup_action.id).to eq(54_321)
       expect(ak_event_signup_action.event_signup_id).to eq('888')
       expect(ak_event_signup_action.user_id).to eq('111')
     end

data/spec/lib/action_kit_rest/allowed_user_field_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActionKitRest::AllowedUserField do
   let(:status) { 200 }
-  let(:standard_headers) { {content_type: "application/json; charset=utf-8"} }
+  let(:standard_headers) { { content_type: 'application/json; charset=utf-8' } }
 
   subject { ActionKitRest.new(host: 'test.com', username: 'alice', password: 'somesecret') }
 
@@ -19,7 +21,7 @@ describe ActionKitRest::AllowedUserField do
     let(:response_body) { fixture('allowed_user_field/list.json') }
 
     before :each do
-      stub_get(request_path).with(basic_auth: ['alice', 'somesecret'])
+      stub_get(request_path).with(basic_auth: %w[alice somesecret])
                             .to_return(body: response_body,
                                        status: status,
                                        headers: standard_headers)
@@ -38,7 +40,7 @@ describe ActionKitRest::AllowedUserField do
     let(:response_body) { fixture('allowed_user_field/list_filtered.json') }
 
     before :each do
-      stub_get(request_path).with(basic_auth: ['alice', 'somesecret'])
+      stub_get(request_path).with(basic_auth: %w[alice somesecret])
                             .to_return(body: response_body,
                                        status: status,
                                        headers: standard_headers)
@@ -52,26 +54,26 @@ describe ActionKitRest::AllowedUserField do
 
   describe '#create' do
     let(:create_request_path) { 'alloweduserfield/' }
-    let(:create_request_body) { {name: 'foo'}.to_json }
+    let(:create_request_body) { { name: 'foo' }.to_json }
     let(:create_status) { 201 }
     let(:created_url) { 'https://test.com/rest/v1/alloweduserfield/foo/' }
     let(:get_request_path) { 'alloweduserfield/foo/' }
     let(:get_response_body) { fixture('allowed_user_field/get.json') }
 
     before :each do
-      stub_post(create_request_path).with(basic_auth: ['alice', 'somesecret'],
+      stub_post(create_request_path).with(basic_auth: %w[alice somesecret],
                                           body: create_request_body)
                                     .to_return(status: create_status,
                                                headers: standard_headers.merge(Location: created_url))
 
-      stub_get(get_request_path).with(basic_auth: ['alice', 'somesecret'])
+      stub_get(get_request_path).with(basic_auth: %w[alice somesecret])
                                 .to_return(body: get_response_body,
                                            status: status,
                                            headers: standard_headers)
     end
 
     it 'should POST to the endpoint, then do a GET on the created object' do
-      field = subject.allowed_user_field.create({name: 'foo'})
+      field = subject.allowed_user_field.create({ name: 'foo' })
       expect(field.display_name).to eq 'Foo'
     end
   end

data/spec/lib/action_kit_rest/api_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/shared_contexts/stub_logger'
+
+describe ActionKitRest::API do
+  include_context 'stub_logger'
+
+  subject { ActionKitRest::API.new(host: 'example.com', username: 'foo', password: 'bar') }
+
+  describe 'error detection' do
+    let(:request_body) { {some: 'data'} }
+
+    before :each do
+      stub_request(:post, 'https://example.com/rest/v1/something/')
+        .to_return(status: response_status, body: response_body,
+                   headers: { content_type: 'application/json; charset=utf-8' })
+    end
+
+    context 'successful response' do
+      let(:response_status) { 200 }
+      let(:response_body) { '{"message": "good job!"}' }
+
+      it 'should not raise' do
+        subject.post_request('something/', request_body)
+      end
+    end
+
+    context '400 response' do
+      let(:response_status) { 400 }
+
+      context 'unable to associate mailing ID' do
+        let(:response_body) { '{"errors": {"mailing_id": ["Unable to associate this mailing ID with account."]}}' }
+
+        it 'should raise an InvalidAkidError' do
+          expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::InvalidAkidError)
+        end
+      end
+
+      context 'unable to associate mailing ID error in Hebrew' do
+        let(:response_body) { '{"errors": {"mailing_id": ["לא הצלחנו לקשר בין מספר הזיהוי של רשימת הדיוור הזו לבין החשבון."]}}' }
+
+        it 'should raise an InvalidAkidError' do
+          expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::InvalidAkidError)
+        end
+      end
+
+      context 'other error' do
+        let(:response_body) { '{"errors": {"zip": ["There is something wrong with your ZIP code!"]}}' }
+
+        it 'sould raise a ValidationError' do
+          expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::ValidationError)
+        end
+      end
+
+      context 'no errors key in response' do
+        let(:response_body) { '{"strange": "things are happening here"}' }
+
+        it 'sould raise a ValidationError' do
+          expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::ValidationError)
+        end
+      end
+    end
+
+    context '401 response' do
+      let(:response_status) { 401 }
+      let(:response_body) { '{"error": "Your API key is no good"}' }
+
+      it 'should raise an Unauthorized exception' do
+        expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::Unauthorized)
+      end
+    end
+
+    context '404 response' do
+      let(:response_status) { 404 }
+      let(:response_body) { '{"error": "not found"}' }
+
+      it 'should raise a NotFound exception' do
+        expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::NotFound)
+      end
+    end
+
+    context '500 response' do
+      let(:response_status) { 500 }
+
+      context 'Try Again Later message' do
+        let(:response_body) { '{"error": "Sorry, this request could not be processed. Please try again later."}' }
+
+        it 'should raise a TryAgainLater exception' do
+          expect{ subject.post_request('something/', request_body) }.to raise_error(ActionKitRest::Response::TryAgainLater)
+        end
+      end
+
+      context 'other error message' do
+        let(:response_body) { '{"error": "Something is wrong, we will fix it!"}' }
+
+        it 'should raise a StandardError' do
+          expect{ subject.post_request('something/', request_body) }.to raise_error(StandardError)
+        end
+      end
+    end
+  end
+end

data/spec/lib/action_kit_rest/logger_spec.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActionKitRest do
   describe 'logging' do
-    it "should have a logger" do
+    it 'should have a logger' do
       ActionKitRest.respond_to?(:logger).should be_truthy
     end
 
-    it "should be able to log debug methods" do
+    it 'should be able to log debug methods' do
       ActionKitRest.logger.respond_to?(:debug).should be_truthy
     end
 
-    it "should be settable" do
+    it 'should be settable' do
       ActionKitRest.respond_to?(:logger=).should be_truthy
-      log = double()
+      log = double
       ActionKitRest.logger = log
       ActionKitRest.logger.should == log
     end
   end
-end
+end

data/spec/lib/action_kit_rest/page_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActionKitRest::Page do
@@ -16,7 +18,7 @@ describe ActionKitRest::Page do
       subject.connection.configuration.host.should == 'test.com'
     end
 
-    it "should have a client" do
+    it 'should have a client' do
       subject.page.client.should_not be_nil
     end
 
@@ -29,82 +31,80 @@ describe ActionKitRest::Page do
     end
   end
 
-
-  describe "retrieval" do
+  describe 'retrieval' do
     before(:each) do
-      stub_get(request_path).to_return(:body => body, :status => status,
-                                       :headers => {:content_type => "application/json; charset=utf-8"})
+      stub_get(request_path).to_return(body: body, status: status,
+                                       headers: { content_type: 'application/json; charset=utf-8' })
     end
 
-    describe ".list" do
+    describe '.list' do
       let(:status) { 200 }
       let(:body) { fixture('page/collection.json') }
       let(:request_path) { 'page/' }
 
-      it "should allow listing the objects" do
+      it 'should allow listing the objects' do
         pages = subject.page.list
 
         pages.should be_an_instance_of(ActionKitRest::Response::Wrapper)
 
-        pages.each do | obj |
+        pages.each do |obj|
           obj.should be_an_instance_of(Hashie::Mash)
           obj.should respond_to(:goal)
         end
       end
     end
 
-    describe ".page" do
-
+    describe '.page' do
       let(:body) { fixture('page/object.json') }
       let(:request_path) { 'page/1/' }
 
-      describe "success" do
+      describe 'success' do
         let(:status) { 200 }
-        it "should return a single object" do
+        it 'should return a single object' do
           page = subject.page.get(1)
           page.goal.should == 10
         end
       end
 
-      describe "not found" do
+      describe 'not found' do
         let(:status) { 404 }
 
-        it "should return nil" do
-          lambda{ subject.page.get(1).should == nil }.should raise_exception(ActionKitRest::Response::NotFound)
+        it 'should return nil' do
+          -> { subject.page.get(1).should.nil? }.should raise_exception(ActionKitRest::Response::NotFound)
         end
       end
-      
-      describe "error" do
+
+      describe 'error' do
         let(:status) { 400 }
         let(:body) { fixture('error.json') }
-        
-        it "should raise an ak validation response error" do
-          lambda{ subject.page.get(1) }.should raise_exception(ActionKitRest::Response::ValidationError)
-        end  
+
+        it 'should raise an ak validation response error' do
+          -> { subject.page.get(1) }.should raise_exception(ActionKitRest::Response::ValidationError)
+        end
       end
 
       describe 'mailing ID error' do
         let(:status) { 400 }
         let(:body) { '{"errors": {"mailing_id": ["Unable to associate this mailing ID with account."]}}' }
 
-        it "should raise an Invalid AKID response error" do
-          lambda{ subject.page.get(1) }.should raise_exception(ActionKitRest::Response::InvalidAkidError)
+        it 'should raise an Invalid AKID response error' do
+          -> { subject.page.get(1) }.should raise_exception(ActionKitRest::Response::InvalidAkidError)
         end
       end
 
-      describe "an error" do
+      describe 'an error' do
         let(:status) { 500 }
 
-        it "should return nil" do
-          lambda{ subject.page.get(1).should == nil }.should raise_exception(StandardError)
+        it 'should return nil' do
+          -> { subject.page.get(1).should.nil? }.should raise_exception(StandardError)
         end
       end
 
       describe 'try again' do
         let(:status) { 500 }
         let(:body) { '{"error": "Sorry, this request could not be processed. Please try again later."}' }
-        it "should return nil" do
-          lambda{ subject.page.get(1).should == nil }.should raise_exception(ActionKitRest::Response::TryAgainLater)
+        it 'should return nil' do
+          -> { subject.page.get(1).should.nil? }.should raise_exception(ActionKitRest::Response::TryAgainLater)
         end
       end
     end