apisync 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3baebf434178862cf7ad0513124cfa460f1ed8c
-  data.tar.gz: 89cfa8062601ae2a64b15a52072303789e97f027
+  metadata.gz: b45094cd8302949db5ed09514381ba31e9901ec4
+  data.tar.gz: 99ba7178a22c9a1894a9ffac0b7ec9bbc5d72e70
 SHA512:
-  metadata.gz: 7e87c8cf404ed809e67588896489dafc1bfcba4a3fdd5e069be68d4f38b38b365f54b9fac016568e15a22c1afbd4b12815a6a03296edcde66e6a62b75f09650e
-  data.tar.gz: c1bd720f4e8700182878c26f649c7b0ddfc10dab926159052194007c22f9646dd22859d7063c7840339058d573dd2278907b4265ef53c75f757240f732c5fb4c
+  metadata.gz: 9e54efe32dadb1fe4832132ffa6635c8f737042a74d218887af6d81ef5d6e46585fbc6e34a3e1e9d455f4c99e38d6af2651b193aee6bbb008c802575940e15d1
+  data.tar.gz: e5da6cfb47427a575b9db484382e7f491471678193790e2716f3f13ca5c3478efc4c9193001958d9921b43344e8a7f4e50325ef0c6dfcc991ba2b4b953ad041b

data/README.md

@@ -1,4 +1,4 @@
-# Apisync
+# apisync-ruby
 
 This gem gives you the tools to interact with [apisync.io](apisync.io).
 
@@ -12,6 +12,10 @@ gem 'apisync'
 
 ## Usage
 
+**On Rails?** Please use
+[apisync-rails](https://github.com/apisync/apisync-rails) instead. It has
+automatic integration with ActiveRecord.
+
 ### Vanilla Ruby
 
 To create an inventory item:
@@ -21,15 +25,29 @@ client = Apisync.new(api_key: token)
 client.inventory_items.save({
   attributes: {
     ad_template_type: "vehicle",
-    availability: "on-sale",
-    brand: "brand",
-    condition: "new",
-    content_language: "pt-br"
-    # ... more attributes
+    available:        true,
+    brand:            "brand",
+    condition:        "new",
+    content_language: "pt-br",
+    reference_id:     "1"
+
+    # more attributes
   }
 })
 ```
 
+For details on the attributes, see the
+[API Reference documentation](https://docs.apisync.io/api/).
+
+You can also define a global API key:
+
+```ruby
+Apisync.api_key = "my-key"
+
+# Instantiate the client now without passing a token
+client = Apisync.new
+```
+
 ## Development
 
 To run tests:

data/apisync.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
 end

data/lib/apisync/exceptions.rb

@@ -4,4 +4,5 @@ class Apisync
   # List of exceptions. They are all inherited from Apisync::Exception
   class UrlAndPayloadIdMismatch < Apisync::Exception; end
   class InvalidFilter < Apisync::Exception; end
+  class TooManyRequests < Apisync::Exception; end
 end

data/lib/apisync/http_client.rb

@@ -7,58 +7,58 @@ class Apisync
       "Accept"       => "application/vnd.api+json"
     }.freeze
 
-    def self.post(resource_name:, data:, options: {})
-      url = Apisync::Http::Url.new(
-        resource_name: resource_name,
-        options: options
-      )
-      payload = payload_from_data(data)
-      HTTParty.post(
-        url.to_s,
-        body: {data: payload}.to_json,
-        headers: header(api_key: options[:api_key])
-      )
+    def initialize(resource_name:, options: {})
+      @resource_name = resource_name
+      @options = options
     end
 
-    def self.put(resource_name:, id:, data:, options: {})
+    def post(data:, headers: {})
+      wrap_response(HTTParty.post(
+        url,
+        body: {data: payload_from_data(data)}.to_json,
+        headers: header.merge(headers)
+      ))
+    end
+
+    def put(id:, data:, headers: {})
       raise Apisync::UrlAndPayloadIdMismatch unless id == data[:id]
 
-      url = Apisync::Http::Url.new(
-        resource_name: resource_name,
-        id: id,
-        options: options
-      )
-      payload = payload_from_data(data)
-      HTTParty.put(
-        url.to_s,
-        body: {data: payload}.to_json,
-        headers: header(api_key: options[:api_key])
-      )
+      wrap_response(HTTParty.put(
+        url(id: id),
+        body: {data: payload_from_data(data)}.to_json,
+        headers: header.merge(headers)
+      ))
     end
 
-    def self.get(resource_name:, id: nil, filters: nil, options: {})
+    def get(id: nil, filters: nil, headers: {})
       raise Apisync::InvalidFilter if !filters.nil? && !filters.is_a?(Hash)
 
-      url = Apisync::Http::Url.new(
-        resource_name: resource_name,
-        id: id,
-        filters: filters,
-        options: options
-      )
-      HTTParty.get(url.to_s, headers: header(api_key: options[:api_key]))
+      wrap_response(HTTParty.get(
+        url(id: id, filters: filters),
+        headers: header.merge(headers)
+      ))
     end
 
     private
 
-    def self.header(api_key: nil)
+    def url(id: nil, filters: nil)
+      Apisync::Http::Url.new(
+        resource_name: @resource_name,
+        id: id,
+        filters: filters,
+        options: @options
+      ).to_s
+    end
+
+    def header
       final = HEADER
-      if api_key
-        final = final.merge("Authorization" => "ApiToken #{api_key}")
+      if @options[:api_key]
+        final = final.merge("Authorization" => "ApiToken #{@options[:api_key]}")
       end
       final
     end
 
-    def self.payload_from_data(data)
+    def payload_from_data(data)
       transformed_payload = {}
       data.each do |key, value|
         if value.is_a?(Hash)
@@ -70,5 +70,13 @@ class Apisync
       end
       transformed_payload
     end
+
+    def wrap_response(response)
+      if response.code.to_i == 429
+        raise Apisync::TooManyRequests
+      else
+        response
+      end
+    end
   end
 end

data/lib/apisync/resource.rb

@@ -12,10 +12,12 @@ class Apisync
     #
     def save(data)
       data[:type] = @name.to_s.gsub("_", "-")
+      headers = data.delete(:headers) || {}
+
       if data[:id].nil?
-        post(data)
+        post(data, headers: headers)
       else
-        put(data)
+        put(data, headers: headers)
       end
     end
 
@@ -30,38 +32,41 @@ class Apisync
     #   get(filters: {column_name: 'customer-id' }})
     #
     def get(conditions)
-      http_client.get(
+      client = Apisync::HttpClient.new(
         resource_name: @name,
+        options: @options
+      )
+      client.get(
         id: conditions[:id],
         filters: conditions[:filters],
-        options: @options
+        headers: conditions[:headers] || {}
       )
     end
 
     private
 
 
-    def post(data)
-      http_client.post(
+    def post(data, headers: {})
+      client = Apisync::HttpClient.new(
         resource_name: @name,
-        data: data,
         options: @options
       )
+      client.post(
+        data: data,
+        headers: headers
+      )
     end
 
-    def put(data)
-      http_client.put(
+    def put(data, headers: {})
+      client = Apisync::HttpClient.new(
         resource_name: @name,
+        options: @options
+      )
+      client.put(
         id: data[:id],
         data: data,
-        options: @options
+        headers: headers
       )
     end
-
-    private
-
-    def http_client
-      Apisync::HttpClient
-    end
   end
 end

data/lib/apisync/version.rb

@@ -1,3 +1,3 @@
 class Apisync
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apisync
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - chavedomundo@gmail.com