my_target_api 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76fbfb40d5a8fa68ba34cad0129fb48bb8c3286a
-  data.tar.gz: 3057b9d92c561324c9e671a3aa0f773f0c2da066
+  metadata.gz: 29d637416775f256beda271796924a188a577f31
+  data.tar.gz: 0764dacd1b9b341b72730ed142866c7c05b02383
 SHA512:
-  metadata.gz: b2f698627d980f93785cbe9fa89a8abb7c13b50820f342f4d93a823aa5abcd2412b8c86298608db353518b02cd69e0def79553321ba0c651da499f3c2455a2d5
-  data.tar.gz: 555210e11984496c154ca494ba299caccc9e4d93beb15009afc6aac4f54d976240e79c4b1b3db4740fe71b6090dd99dae065959857d50d36ab99d0f5b7024eae
+  metadata.gz: 89d329c205f1792ce8173ce52af161aee3eaa12b780257ec4cf3714a7f2548ca7ac510477453d2cc6f683ff954480529be9dde9a13a81ab877f58de8c3935f47
+  data.tar.gz: cc342e1016adc4a9760b738081cd6b382238b32744e028db90b15156619b6c8a97cd5a2415e3d79c261698d59d69b56be5c4e786e5ce556a97ee6586b56cc79a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_target_api (1.0.3)
+    my_target_api (1.0.4)
       json (~> 2.0, >= 2.0.0)
       rest-client (~> 2.0, >= 2.0.0)
 

data/README.md

@@ -7,7 +7,7 @@
 Add this line to your application's Gemfile:
 
 ```
-gem 'my_target_api', '~> 1.0.3'
+gem 'my_target_api', '~> 1.0.4'
 ```
 
 Or install from command line:
@@ -19,12 +19,14 @@ $ gem install my_target_api
 ## Usage
 
 ### Initialization
+
 ```ruby
 # You need an access token to use API
 my_target_api = MyTargetApi.new(access_token)
 ```
 
 ### Resources
+
 ```ruby
 # root resources
 campaigns_resource = my_target_api.resource('campaigns')
@@ -36,6 +38,7 @@ remarketing_counters_resource = remarketing_resource.resource('counters')
 ```
 
 ### Create, Read, Update, Delete
+
 ```ruby
 remarketing_counters_resource.create(counter_id: 121212) # => [{ 'id' => 343434 }]
 
@@ -48,6 +51,15 @@ campaigns_resource.update(id: 12345, status: 'blocked') # => [{ 'id' => 12345, '
 remarketing_counters_resource.delete(id: 343434) # => [{ 'success' => true }]
 ```
 
+### File upload
+
+```ruby
+static_resource = my_target_api.resource('content/static', v: 2)
+picture = File.new('path/to/picture.jpg', 'rb')
+
+static_resource.create(file: picture, data: { width: 1200, height: 800 })
+```
+
 ## Exceptions
 
 ```ruby

data/lib/my_target_api/{errors/connection_error.rb → connection_error.rb}

@@ -4,8 +4,8 @@ class MyTargetApi
   # Error class
   class ConnectionError < StandardError
 
-    def initialize(e)
-      @exception = e
+    def initialize(exception)
+      @exception = exception
     end
 
     def message

data/lib/my_target_api/{errors/request_error.rb → request_error.rb}

@@ -4,21 +4,21 @@ class MyTargetApi
   # Error for request
   class RequestError < StandardError
 
-    def initialize(e)
-      super build_message e
+    def initialize(exception)
+      super build_message exception
     end
 
     private
 
-    def build_message(e)
-      body = JSON.parse e.response
+    def build_message(exception)
+      body = JSON.parse exception.response
       if body['error']
         "#{body['error']} : #{body['error_description']}"
       else
         body.map { |field, error| "#{field}: #{error}" }.join(', ')
       end
     rescue StandardError
-      e.response
+      exception.response
     end
 
   end

data/lib/my_target_api/resource.rb

@@ -29,6 +29,7 @@ class MyTargetApi
     def update(params = {})
       params = prepare_params(params)
       id = params.delete(:id)
+      raise ArgumentError, ':id is required' unless id
 
       api.post_request("#{path}/#{id}.json", params)
     end
@@ -36,6 +37,7 @@ class MyTargetApi
     def delete(params = {})
       params = prepare_params(params)
       id = params.delete(:id)
+      raise ArgumentError, ':id is required' unless id
 
       api.delete_request("#{path}/#{id}.json", params)
     end
@@ -49,7 +51,7 @@ class MyTargetApi
     attr_reader :api, :path
 
     def prepare_params(params)
-      raise UsingError, 'Params must be a Hash' unless params.is_a? Hash
+      raise ArgumentError, 'Params must be a Hash' unless params.is_a? Hash
 
       params.map do |param, value|
         [param.to_sym, value]

data/lib/my_target_api/version.rb

@@ -2,6 +2,6 @@
 
 class MyTargetApi
 
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 
 end

data/lib/my_target_api.rb

@@ -7,10 +7,10 @@ class MyTargetApi
 
   autoload :Resource, 'my_target_api/resource'
   autoload :Request, 'my_target_api/request'
-  autoload :Session, 'my_target_api/session'
 
-  autoload :ConnectionError, 'my_target_api/errors/connection_error'
-  autoload :RequestError, 'my_target_api/errors/request_error'
+  autoload :ConnectionError, 'my_target_api/connection_error'
+  autoload :RequestError, 'my_target_api/request_error'
+  autoload :InterfaceError, 'my_target_api/using_error'
 
   def initialize(access_token, options = {})
     @access_token = access_token

data/spec/request_spec.rb

@@ -38,5 +38,13 @@ describe MyTargetApi::Request do
         subject.delete('https://target.my.com/api/v1/remarketing_context_phrases/53.json')
       ).to eq([{ 'success' => true }])
     end
+
+    it 'raises exception on bad statuses' do
+      stub_request(:get, 'https://target.my.com/api/v1/wrong_path.json')
+        .to_return(body: 'Unknown resource', status: 404)
+
+      expect { subject.get('https://target.my.com/api/v1/wrong_path.json') }
+        .to raise_error(MyTargetApi::RequestError, 'Unknown resource')
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_target_api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Reshetnikov Ivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -154,11 +154,9 @@ files:
 - README.md
 - Rakefile
 - lib/my_target_api.rb
-- lib/my_target_api/auth.rb
-- lib/my_target_api/errors/connection_error.rb
-- lib/my_target_api/errors/request_error.rb
-- lib/my_target_api/errors/using_error.rb
+- lib/my_target_api/connection_error.rb
 - lib/my_target_api/request.rb
+- lib/my_target_api/request_error.rb
 - lib/my_target_api/resource.rb
 - lib/my_target_api/version.rb
 - my_target_api.gemspec

data/lib/my_target_api/auth.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-# see https://target.my.com/doc/api/oauth2
-
-class MyTargetApi
-  # authorization
-  class Auth
-
-    class << self
-
-      include MyTargetApi::Request
-
-      def authorize_url
-        state = (0...32).map { rand(65..90).chr }.join.downcase
-        'https://target.my.com/oauth2/authorize?response_type=code' \
-          "&client_id=#{MyTargetApi.client_id}&state=#{state}&scope=#{MyTargetApi.scopes}"
-      end
-
-      # We need new method to receive token using `agency_client_credentials` grant type
-      # @param client_username [String] client user_name in myTarget
-      # @return [Hash] containing requested access_token
-      def get_agency_client_credentials(client_username)
-        params = { grant_type: 'agency_client_credentials',
-                   agency_client_name: client_username,
-                   v: 2 }
-        request :post, '/oauth2/token', params
-      end
-
-      def get_token(code)
-        params = { grant_type: 'authorization_code', code: code, v: 2 }
-        request :post, '/oauth2/token', params
-      end
-
-      def refresh_token(code)
-        params = { grant_type: 'refresh_token', refresh_token: code, v: 2 }
-        request :post, '/oauth2/token', params
-      end
-
-    end
-
-  end
-end

data/lib/my_target_api/errors/using_error.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class MyTargetApi
-  # You are using library in a wrong way
-  class UsingError < StandardError
-  end
-end