my_target_api 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e53adbd2b5a083b0fb9e90646dac235545237336
-  data.tar.gz: 88bfab044cf0b2214ff029443786e7dc4ad82f76
+  metadata.gz: 35b5e8e2f9e33078a2823459568b54d17097d849
+  data.tar.gz: 4569d9039f9193f3bf00a8d6a29e86bca3202238
 SHA512:
-  metadata.gz: fc6883a6ba4ce7b7dacd71d54b0d74adca74b92db223a88e5d79b6e129e2fb8a0ef81f6a53c64da507660658e62014ba0c4ce603160b269bac82c243de750106
-  data.tar.gz: 7a88cc9582adea5d6f358b166640fc62d2e391eda2b14e39e1ed460406e489c244c5b42ec8310c89cba4c9c50101efda9283c3b5e8d8a068e1f7a377c2cbe338
+  metadata.gz: d9e6bc0d5e187b837fdcbf9d41297bb94eef2bbd63cdc6c0cf3def44049e1923fb16142ad30742ac62e3e5f4198061de9dcae1741eb6bbfe64d413ee16b620aa
+  data.tar.gz: 0ae105819862e9b089fd8dfa04e164262fc565e0a6ad4c4d633e9963798a52b24ca79338760e39f162a17296f1224d50c8ad0bcc318118fab2355f7e48cdcb83

data/README.md

@@ -7,7 +7,7 @@
 Add this line to your application's Gemfile:
 
 ```
-gem 'my_target_api', '~> 1.0.5'
+gem 'my_target_api', '~> 1.1.0'
 ```
 
 Or install from command line:
@@ -60,6 +60,15 @@ picture = File.new('path/to/picture.jpg', 'rb')
 static_resource.create(file: picture, data: { width: 1200, height: 800 })
 ```
 
+### Raw data upload
+
+```ruby
+search_phrases_resource = my_target_api.resource('search_phrases', v: 2)
+phrases = "phrase\nfirst phrase\nsecond phrase\n"
+
+search_phrases_resource.upload(phrases, name: 'search phrases list')
+```
+
 ## Exceptions
 
 ```ruby

data/lib/my_target_api.rb

@@ -10,7 +10,6 @@ class MyTargetApi
 
   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
@@ -36,6 +35,10 @@ class MyTargetApi
     request_object.delete(url, params.merge(access_token: access_token))
   end
 
+  def upload_request(url, content, params)
+    request_object.upload(url, content, params.merge(access_token: access_token))
+  end
+
   private
 
   attr_reader :access_token, :options

data/lib/my_target_api/request.rb

@@ -13,7 +13,7 @@ class MyTargetApi
 
     def get(url, params = {})
       response = with_exception_handling do
-        RestClient.get(url, headers(params).merge(params: header_parameters(params)))
+        RestClient.get(url, headers(params).merge(query(params)))
       end
 
       process_response(response)
@@ -29,7 +29,15 @@ class MyTargetApi
 
     def delete(url, params = {})
       response = with_exception_handling do
-        RestClient.delete(url, headers(params).merge(params: header_parameters(params)))
+        RestClient.delete(url, headers(params).merge(query(params)))
+      end
+
+      process_response(response)
+    end
+
+    def upload(url, content, params = {})
+      response = with_exception_handling do
+        RestClient.post(url, content, headers(params).merge(query(params)))
       end
 
       process_response(response)
@@ -62,6 +70,10 @@ class MyTargetApi
       result_params
     end
 
+    def query(params)
+      { params: header_parameters(params) }
+    end
+
     def headers(params)
       { Authorization: "Bearer #{params[:access_token]}" }
     end

data/lib/my_target_api/resource.rb

@@ -39,6 +39,12 @@ class MyTargetApi
       end
     end
 
+    def upload(content, params = {})
+      with_prepared_params(params) do |prepared|
+        api.upload_request("#{path}.json", content, prepared)
+      end
+    end
+
     def resource(relative_path)
       MyTargetApi::Resource.new(api, "#{path}/#{relative_path}")
     end

data/lib/my_target_api/version.rb

@@ -2,6 +2,6 @@
 
 class MyTargetApi
 
-  VERSION = '1.0.5'
+  VERSION = '1.1.0'
 
 end

data/spec/request_spec.rb

@@ -39,6 +39,19 @@ describe MyTargetApi::Request do
       ).to eq([{ 'success' => true }])
     end
 
+    it 'uploads raw content' do
+      stub_request(:post, 'https://target.my.com/api/v2/search_phrases.json?name=list')
+        .to_return(body: '{"id": 123, "name": "list"}')
+
+      expect(
+        subject.upload(
+          'https://target.my.com/api/v2/search_phrases.json',
+          "phrase\nfirst\nsecond",
+          name: 'list'
+        )
+      ).to eq('id' => 123, 'name' => 'list')
+    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)

data/spec/resource_spec.rb

@@ -13,38 +13,46 @@ describe MyTargetApi::Resource do
     it { expect(resource).to respond_to :read }
     it { expect(resource).to respond_to :update }
     it { expect(resource).to respond_to :delete }
+    it { expect(resource).to respond_to :upload }
   end
 
   describe '#create' do
-    it 'request path to all objects' do
-      expect(api).to receive(:post_request).with('api_path.json', {})
-      resource.create
+    it 'index request path' do
+      expect(api).to receive(:post_request).with('api_path.json', param: 'param')
+      resource.create(param: 'param')
     end
   end
 
   describe '#read' do
-    it 'request path to all objects' do
-      expect(api).to receive(:get_request).with('api_path.json', {})
-      resource.read
+    it 'index request path' do
+      expect(api).to receive(:get_request).with('api_path.json', param: 'param')
+      resource.read(param: 'param')
     end
 
-    it 'request path to one object' do
-      expect(api).to receive(:get_request).with('api_path/7.json', {})
-      resource.read(id: 7)
+    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')
     end
   end
 
   describe '#update' do
-    it 'request path to all objects' do
-      expect(api).to receive(:get_request).with('api_path.json', {})
-      resource.read
+    it 'index request path' do
+      expect(api).to receive(:get_request).with('api_path.json', param: 'param')
+      resource.read(param: 'param')
     end
   end
 
   describe '#delete' do
-    it 'request path to all objects' do
-      expect(api).to receive(:delete_request).with('api_path/7.json', {})
-      resource.delete(id: 7)
+    it 'request path to a single object' do
+      expect(api).to receive(:delete_request).with('api_path/7.json', param: 'param')
+      resource.delete(id: 7, param: 'param')
+    end
+  end
+
+  describe '#upload' do
+    it 'index request path' do
+      expect(api).to receive(:upload_request).with('api_path.json', 'content', param: 'param')
+      resource.upload('content', param: 'param')
     end
   end
 

data/spec/root_spec.rb

@@ -12,4 +12,5 @@ describe MyTargetApi do
   it { should respond_to :get_request }
   it { should respond_to :post_request }
   it { should respond_to :delete_request }
+  it { should respond_to :upload_request }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_target_api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - OneRetarget.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json