apisync 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cce9df4729e3a774cf37ff0a4105f6d35959639
-  data.tar.gz: f867abbe3f8ae536365851eca6826613db5b1aeb
+  metadata.gz: 6d0eba4134c51dcf6e3a7c1727db5fbad9dcbab6
+  data.tar.gz: 531ee71f557836f25dc58db9671e327bf6a476ad
 SHA512:
-  metadata.gz: 6f0539eb5b4a53299acd5b92844d67e01638b47966ff7dd61a18ccfcac2779362e3e2212d8c2b47c09ec7156c5f66ce905b696fc6129076e3b9552b6a7759c6c
-  data.tar.gz: 480b7c6c67dcbf740b5844a94aa9375614336eb884920130b9e0e0d203d8a1d9bba955f5f24432895c2e4aeeba21441d472da4dfe3c53bdf6bb215f5ba579454
+  metadata.gz: b6d04b2709ef4f99351fefce81e93f54bc25d6fa8703483d3cbaf50734b6badb475d0708bc0315941f143f047d1e6f12f4be127c1d964170cce6b58b13939c87
+  data.tar.gz: 68a6179d0c0b8684355c1d6a44bcd241f5709a4990458f6a728ac390f857be39a84003eeef62512e597044865bb8bc1419aeb49a305b6fa83cdc88e6fcbc30dd

data/README.md

@@ -39,7 +39,7 @@ client.inventory_items.save({
 For details on the attributes, see the
 [API Reference documentation](https://docs.apisync.io/api/).
 
-You can also define a global API key:
+You can also define the API key globally:
 
 ```ruby
 Apisync.api_key = "my-key"
@@ -48,6 +48,32 @@ Apisync.api_key = "my-key"
 client = Apisync.new
 ```
 
+#### Verbose
+
+If you want to output to `$stdout`, set `verbose: true`:
+
+```rb
+# Define in the instance
+client = Apisync.new(api_key: 'api-key', verbose: true)
+
+# or define it globally
+Apisync.verbose = true
+```
+
+That is useful on Rails console in development mode, so you know what requests
+are being made
+
+**Logger**
+
+You can inject a logger as well:
+
+```rb
+Apisync.logger = Logger.new($stdout)
+
+# or
+Apisync.logger = Rails.logger
+```
+
 ### Responses
 
 All HTTP calls return an

data/lib/apisync.rb

@@ -1,5 +1,7 @@
 require "bundler/setup"
 require "httparty"
+require "securerandom"
+require "logger"
 
 require "apisync/version"
 require "apisync/exceptions"
@@ -12,9 +14,19 @@ class Apisync
   @@api_key = nil
   @@host = nil
 
-  def initialize(api_key: nil)
+  # Verbose will do $stdout.puts. That's useful on a Rails console in
+  # development, where logger output is ommited.
+  @@verbose = false
+  @@logger = ::Logger.new(IO::NULL)
+
+  attr_accessor :verbose
+
+  def initialize(api_key: nil, verbose: nil, logger: nil)
     @api_key = api_key || @@api_key
     @host = @@host
+    @verbose = verbose || @@verbose
+
+    @logger = logger || @@logger
 
     raise ArgumentError, "missing keyword: api_key" if @api_key.nil?
   end
@@ -22,8 +34,11 @@ class Apisync
   def method_missing(name, args = {}, &block)
     # overrides the instance api_key as `authorization`
     options = {
-      host: @host
+      host: @host,
+      verbose: @verbose,
+      logger: @logger
     }.merge(args).merge(api_key: @api_key)
+
     Apisync::Resource.new(name, options)
   end
 
@@ -34,4 +49,16 @@ class Apisync
   def self.api_key=(value)
     @@api_key = value
   end
+
+  def self.verbose=(value)
+    @@verbose = value
+  end
+
+  def self.logger=(value)
+    @@logger = value
+  end
+
+  def self.verbose?
+    !!@@verbose
+  end
 end

data/lib/apisync/http_client.rb

@@ -10,38 +10,63 @@ class Apisync
     def initialize(resource_name:, options: {})
       @resource_name = resource_name
       @options = options
+      @logger = options[:logger]
     end
 
     def post(data:, headers: {})
+      request_body = {data: payload_from_data(data)}
+      url = request_url
+      header = request_header.merge(headers)
+
+      output_verbose_request(url, request_body, header)
+
       wrap_response(HTTParty.post(
-        url,
-        body: {data: payload_from_data(data)}.to_json,
-        headers: header.merge(headers)
+        request_url,
+        body: request_body.to_json,
+        headers: header
       ))
     end
 
     def put(id:, data:, headers: {})
       raise Apisync::UrlAndPayloadIdMismatch unless id == data[:id]
 
+      request_body = {data: payload_from_data(data)}
+      url = request_url(id: id)
+      header = request_header.merge(headers)
+
+      output_verbose_request(url, request_body, header)
+
       wrap_response(HTTParty.put(
-        url(id: id),
-        body: {data: payload_from_data(data)}.to_json,
-        headers: header.merge(headers)
+        url,
+        body: request_body.to_json,
+        headers: header
       ))
     end
 
     def get(id: nil, filters: nil, headers: {})
       raise Apisync::InvalidFilter if !filters.nil? && !filters.is_a?(Hash)
 
+      url = request_url(id: id, filters: filters)
+      output_verbose_request(url)
+
       wrap_response(HTTParty.get(
-        url(id: id, filters: filters),
-        headers: header.merge(headers)
+        url,
+        headers: request_header.merge(headers)
       ))
     end
 
     private
 
-    def url(id: nil, filters: nil)
+    def verbose?
+      @options.fetch(:verbose, false)
+    end
+
+    def output_verbose_request(url, body = nil, headers = nil)
+      log("[APISync] Request URL: #{url}")
+      log("[APISync] Payload: #{body.to_json}")if body
+    end
+
+    def request_url(id: nil, filters: nil)
       Apisync::Http::Url.new(
         resource_name: @resource_name,
         id: id,
@@ -50,8 +75,9 @@ class Apisync
       ).to_s
     end
 
-    def header
+    def request_header
       final = HEADER
+      final = final.merge("X-Request-Id" => ::SecureRandom.uuid)
       if @options[:api_key]
         final = final.merge("Authorization" => "ApiToken #{@options[:api_key]}")
       end
@@ -73,10 +99,25 @@ class Apisync
 
     def wrap_response(response)
       if response.code.to_i == 429
+        if verbose?
+          log "[APISync] Response: 429 Too many requests at once, slow down."
+        end
         raise Apisync::TooManyRequests
       else
+        if verbose?
+          msg = "[APISync] Response: #{response.code}"
+          if response.body != ""
+            msg << " #{response.body}"
+          end
+          log msg
+        end
         response
       end
     end
+
+    def log(msg)
+      $stdout.puts(msg) if verbose?
+      @logger.info(msg)
+    end
   end
 end

data/lib/apisync/version.rb

@@ -1,3 +1,3 @@
 class Apisync
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apisync
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2018-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty