my_target_api 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45922e11a54d1aa6abf0572f7c1384d4929fe6e7
-  data.tar.gz: c1e7eebe80e5d3a2ab853bf9dd2a590cdf0d3a42
+  metadata.gz: 2d50d6a3938e19d3ecea148ee213ceb7c2a98503
+  data.tar.gz: 2949b7a73006c2f56b86f37b8389ff99d84300cb
 SHA512:
-  metadata.gz: 6825b4699c3a1dbf6d904cdd614fac88aa7ea475bda184d325c3a086bf9bd4e92395a4c20b47472dc0df676a9de7e337d09eca15dc8ccec25558ed6bb94fd79e
-  data.tar.gz: 7c59ffd02cb4cc2317a714bbb6e9b445f2d7e66ae6077482e4cc41b3c17fe2f930338ebc46b69ddcd64ba5b7c5fa1d7a06ec3009a1658e78e14b94531e3780ba
+  metadata.gz: aa92d11653187e0c86863d8744d99e47fdbe6a65f5bbca65007c1436dff1ad6a9f1b8db4e59599952f4c23542e58a285d0633c8b485e8c72df6f5fa33ab4aa3f
+  data.tar.gz: b075284f16d5d546b7e7e8b389f2e4d60c08dcba81ef7a8901681f589f0fea7f81f44601ac5bc37ec6c6ce119e46cde578c10f061430e12dee92222d1fb1bcc6

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    my_target_api (1.2.0)
+      json (~> 2.0, >= 2.0.0)
+      rest-client (~> 2.0, >= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.8)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.1)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  my_target_api!
+  rake (~> 12.3.0, >= 12.3.0)
+  rspec (~> 3.7.0, >= 3.7.0)
+  rubocop (~> 0.54.0)
+  webmock (~> 2.3.2, >= 2.3.2)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -7,7 +7,7 @@
 Add this line to your application's Gemfile:
 
 ```
-gem 'my_target_api', '~> 1.1.1'
+gem 'my_target_api', '~> 1.2.0'
 ```
 
 Or install from command line:
@@ -28,15 +28,22 @@ my_target_api = MyTargetApi.new(access_token)
 ### Resources
 
 ```ruby
-# root resources
+# Root resources
 campaigns_resource = my_target_api.resource('campaigns')
 remarketing_resource = my_target_api.resource('remarketing', v: 2)
 
-# nested resources
+# Nested resources
 remarketing_counters_resource = my_target_api.resource('remarketing/counters', v: 2)
 remarketing_counters_resource = remarketing_resource.resource('counters')
 ```
 
+#### Options
+
+Name | Default value | Description
+---|---|---
+`:v` | 1 | API version
+`:logger` |   | An object to log requests and exceptions. The object must respond to `<<` method
+
 ### Create, Read, Update, Delete
 
 ```ruby
@@ -51,6 +58,19 @@ campaigns_resource.update(id: 12345, status: 'blocked') # => [{ 'id' => 12345, '
 remarketing_counters_resource.delete(id: 343434) # => [{ 'success' => true }]
 ```
 
+#### Options
+
+ Name | Default value | Description 
+---|---|---
+ `:id` |   | Resource ID. Optional for Read, required for Update and Delete
+ `:id_param_key` | `:id` | Option key for resource ID
+
+### Changing default ID param name
+
+```ruby
+campaigns_resource.read(id_key_param: :campaign_id, campaign_id: 12345) # => [{ 'id' => 12345, ... }]
+```
+
 ### File upload
 
 ```ruby
@@ -79,10 +99,17 @@ def read_active_campaigns
 rescue MyTargetApi::RequestError, MyTargetApi::ConnectionError => e
 
   puts e.message, e.backtrace
+  # You can access the original exception
+  puts e.original_exception.message, e.original_exception.backtrace
 
 end
 ```
 
+ Name | Description 
+---|---
+ `MyTargetApi::RequestError` | Request didn't succeed
+ `MyTargetApi::ConnectionError` | Connection didn't succeed
+
 ## Testing
 
 ```

data/lib/my_target_api/connection_error.rb

@@ -4,7 +4,10 @@ class MyTargetApi
   # Error class
   class ConnectionError < StandardError
 
+    attr_reader :original_exception
+
     def initialize(exception)
+      @original_exception = exception
       @exception = exception
     end
 

data/lib/my_target_api/request.rb

@@ -94,14 +94,14 @@ class MyTargetApi
 
     def with_exception_handling
       response = yield
-      logger << response if logger
+      log(response)
       response
-    rescue RestClient::Unauthorized, RestClient::Forbidden,
-           RestClient::BadRequest, RestClient::RequestFailed,
-           RestClient::ResourceNotFound => e
-
+    rescue RestClient::ExceptionWithResponse => e
       log_rest_client_exception(e)
       raise MyTargetApi::RequestError, e
+    rescue RestClient::Exception => e
+      log("#{e.class.name} #{e.message}")
+      raise MyTargetApi::RequestError, e
     rescue SocketError => e
       raise MyTargetApi::ConnectionError, e
     end
@@ -117,19 +117,17 @@ class MyTargetApi
           HTTP headers: #{exception.http_headers}
         LOG
 
-      logger << log_message if logger
+      log(log_message)
     end
 
     def log_hash(hash)
-      return unless logger
-
-      logger << hash.map do |key, value|
+      log(hash.map do |key, value|
         "#{key}: #{value.is_a?(String) ? value : value.inspect}"
-      end.join("\n")
+      end.join("\n"))
     end
 
-    def logger
-      options[:logger]
+    def log(message)
+      options[:logger] << message if options[:logger]
     end
 
   end

data/lib/my_target_api/request_error.rb

@@ -4,7 +4,10 @@ class MyTargetApi
   # Error for request
   class RequestError < StandardError
 
+    attr_reader :original_exception
+
     def initialize(exception)
+      @original_exception = exception
       super build_message exception
     end
 

data/lib/my_target_api/resource.rb

@@ -16,9 +16,7 @@ class MyTargetApi
     end
 
     def read(params = {})
-      with_prepared_params(params) do |prepared|
-        id = prepared.delete(:id)
-
+      with_id_and_prepared_params(params) do |id, prepared|
         if id
           api.get_request("#{path}/#{id}.json", prepared)
         else
@@ -28,13 +26,13 @@ class MyTargetApi
     end
 
     def update(params = {})
-      with_id_and_prepared_params(params) do |id, prepared|
+      with_id_and_prepared_params(params, assert_id_existence: true) do |id, prepared|
         api.post_request("#{path}/#{id}.json", prepared)
       end
     end
 
     def delete(params = {})
-      with_id_and_prepared_params(params) do |id, prepared|
+      with_id_and_prepared_params(params, assert_id_existence: true) do |id, prepared|
         api.delete_request("#{path}/#{id}.json", prepared)
       end
     end
@@ -63,10 +61,11 @@ class MyTargetApi
       yield prepared
     end
 
-    def with_id_and_prepared_params(params)
+    def with_id_and_prepared_params(params, assert_id_existence: false)
       with_prepared_params(params) do |prepared|
-        id = prepared.delete(:id)
-        raise ArgumentError, ':id is required' unless id
+        id_key_param = prepared.delete(:id_param_key) || :id
+        id = prepared.delete(id_key_param.to_sym)
+        raise ArgumentError, ':id is required' if assert_id_existence && id.nil?
 
         yield id, prepared.dup
       end

data/lib/my_target_api/version.rb

@@ -2,6 +2,6 @@
 
 class MyTargetApi
 
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 
 end

data/spec/resource_spec.rb

@@ -29,9 +29,16 @@ describe MyTargetApi::Resource do
       resource.read(param: 'param')
     end
 
-    it 'request path to a single object' do
-      expect(api).to receive(:get_request).with('api_path/7.json', param: 'param')
-      resource.read(id: 7, param: 'param')
+    describe 'request path to a single object' do
+      it 'request path to a single object with default id key' do
+        expect(api).to receive(:get_request).with('api_path/7.json', param: 'param')
+        resource.read(id: 7, param: 'param')
+      end
+
+      it 'request path to a single object with custom id key' do
+        expect(api).to receive(:get_request).with('api_path/8.json', param: 'param')
+        resource.read(id_param_key: :custom_id, custom_id: 8, param: 'param')
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_target_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - OneRetarget.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -149,6 +149,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - lib/my_target_api.rb