my_target_api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c0ba72363e1e3c2b93c8d571dcd528018665986
-  data.tar.gz: 42349e2efdfa1e10f158940125cdd4f2f277c0a3
+  metadata.gz: 60253aa7844b7f653d225c75305b9b051c79c940
+  data.tar.gz: c934fe8dd6d462427089aef5d6a965419f3aa2ab
 SHA512:
-  metadata.gz: 80374c7520aa036d70b3b9a26fcdb7eb16dc85cf1f59e6d183618a65140c30a28247c01399c83fa5b16889a64dd73707426e1b9db6770e0f135679a131f9b0f4
-  data.tar.gz: 0e55cc56d187e2c5d999c666cbdda6807ff1c686467cf26f9684d4502b92dab4dfded6615f9aea0a008e936aca0861c37ba645377cdc89d35d4279142d476047
+  metadata.gz: 7bc0e9b258b4dc79453f8cd7d5c9b91b1e0be31d44d1632690203179d298d0cffd668d29b6b7c9a6229f0aa154f9fc199eb9861e0ea9f3a7683ee3df5d218d7b
+  data.tar.gz: a7fd520c9966ca7027cbb1fcfdc5a23c119c1c6cb9431fcbe60cdb5673815ddc82ce6a6d030002847400fc3bd923f763d74e021a2852edc7d9442ed3cf2e7308

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    my_target_api (1.0.1)
+      json (~> 2.0, >= 2.0.0)
+      rest-client (~> 2.0, >= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      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.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    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.9.0)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.3.0)
+    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,16 +7,10 @@
 Add this line to your application's Gemfile:
 
 ```
-gem 'my_target_api', '~> 1.0.0'
+gem 'my_target_api', '~> 1.0.2'
 ```
 
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself as:
+Or install from command line:
 
 ```
 $ gem install my_target_api
@@ -24,40 +18,47 @@ $ gem install my_target_api
 
 ## Usage
 
+### Initialization
 ```ruby
-# initialization
-api = MyTargetApi.new(access_token)
+# 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')
+remarketing_resource = my_target_api.resource('remarketing', v: 2)
 
-# get api object
-campaigns_api = api.resource('campaigns')
-remarketing_api = api.resource('remarketing', v: 2)
-remarketing_counters_api = remarketing_api.resource('counters')
+# nested resources
+remarketing_counters_resource = my_target_api.resource('remarketing/counters', v: 2)
+remarketing_counters_resource = remarketing_resource.resource('counters')
+```
 
-# create
-remarketing_counters_api.create(counter_id: 121212) # => [{ id: 343434 }]
+### Create, Read, Update, Delete
+```ruby
+remarketing_counters_resource.create(counter_id: 121212) # => [{ id: 343434 }]
 
-# read all
-campaigns_api.read # => [{ id: 12345, ... }, { ... }]
+campaigns_resource.read # => [{ id: 12345, ... }, { ... }]
 
-# read
-campaigns_api.read(id: 12345) # => [{ id: 12345, ... }]
+campaigns_resource.read(id: 12345) # => [{ id: 12345, ... }]
 
-# update
-campaigns_api.update(id: 12345, status: 'blocked') # => [{ id: 12345, status: 'blocked' }]
+campaigns_resource.update(id: 12345, status: 'blocked') # => [{ id: 12345, status: 'blocked' }]
 
-# delete
-remarketing_counters_api.delete(id: 343434) # => true
+remarketing_counters_resource.delete(id: 343434) # => true
 ```
 
 ## Exceptions
 
 ```ruby
 def read_active_campaigns
-  campaigns_api.read(status: 'active')
+
+  campaigns_resource.read(status: 'active')
+
 rescue MyTargetApi::RequestError, MyTargetApi::ConnectionError => e
-  logger.error(e)
-  raise
+
+  puts e.message, e.backtrace
+
 end
 ```
 

data/lib/my_target_api/request.rb

@@ -28,11 +28,11 @@ class MyTargetApi
     end
 
     def delete(url, params = {})
-      response = with_exception_handling do
+      with_exception_handling do
         RestClient.delete(url, headers(params).merge(params: header_parameters(params)))
       end
 
-      process_response(response)
+      true
     end
 
     def body_parameters(params)

data/lib/my_target_api/version.rb

@@ -2,6 +2,6 @@
 
 class MyTargetApi
 
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 
 end

data/my_target_api.gemspec

@@ -10,7 +10,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Reshetnikov Ivan']
   spec.email         = ['help@oneretarget.com']
   spec.summary       = 'Ruby client for myTarget API'
-  spec.description   = 'This library was created by OneRetarget.com - advertising automation service'
+  spec.description   = <<~DESC
+    Ruby client for myTarget API.
+    It takes care of JSON parsing, file parameters, nested resources, api versions.
+    OneRetarget.com - advertising automation service
+  DESC
   spec.homepage      = 'https://github.com/resivalex/my_target_api'
   spec.license       = 'MIT'
 

data/spec/request_spec.rb

@@ -29,5 +29,14 @@ describe MyTargetApi::Request do
       expect(subject.get('https://target.my.com/api/v1/vk_groups.json', q: 'unfound'))
         .to eq([])
     end
+
+    it 'deletes object' do
+      stub_request(:delete, 'https://target.my.com/api/v1/remarketing_context_phrases/53.json')
+        .to_return(body: '[]')
+
+      expect(
+        subject.delete('https://target.my.com/api/v1/remarketing_context_phrases/53.json')
+      ).to eq(true)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_target_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Reshetnikov Ivan
@@ -138,8 +138,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.2
-description: This library was created by OneRetarget.com - advertising automation
-  service
+description: |
+  Ruby client for myTarget API.
+  It takes care of JSON parsing, file parameters, nested resources, api versions.
+  OneRetarget.com - advertising automation service
 email:
 - help@oneretarget.com
 executables: []
@@ -147,6 +149,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile