fulfil-io 0.4.2 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35c4c9a9a5c6e89dc1963296ecb2d2bef838a93fe67f4d16b2cc6d1234870787
-  data.tar.gz: 54030ba2a9cffd08d0f720a195cb29196a8bc38d6860fc7ff30e59b3328f97a9
+  metadata.gz: 21d5119cc38db9e9a414775dcfc9b37d53ca5fa3ff05218c4ae81bbc912d0695
+  data.tar.gz: a4bf8e9ae17a2993c1a3644d298e39f71c78b1eddc40f6bb20d35bdb25ad1ba5
 SHA512:
-  metadata.gz: 1b73ec09fc10b8183ed80d0f60bfe8911394c8d8e624a28e8d4aa77889a2912673876faf5af204ada89ba87ee9fff32796fb8b43a2b6825c1eb91eaf3773fb47
-  data.tar.gz: a0251fe789efa3744c331e5b590f64a0ce6dd100b204e0413b98d925733c99fda0be8ba2d5e8fb7e7fc2793a1f26b25030b58bdab61ee69bf3b68c59154c9582
+  metadata.gz: b1fc2fe57cb22c234b12ffe3c0182030baa3be525971eaa7a2f21470e36f5ef9f6957919ba3675574c1159c79ff3b40f28b11167927ce8f852e70fed667f01b3
+  data.tar.gz: 1406056b1b4f566163829b91dd96822c1705286528581567f74d1c383146652a10e0788fd1b80bab81fa79088a32a65440c72483f70fc8c22ae073e9115f19fa

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.4.7
+
+* Bugfix: Accidentally removed the model parameter from the URL.
+
+## 0.4.6
+
+* Add InteractiveReport support.
+
+## 0.4.5
+
+* Add #delete to client.
+* Set up Dependabot on GitHub.
+
+## 0.4.4
+
+* Pin http dependency to ~> 4.4.0. 5.0+ introduces a frozen string error.
+
+## 0.4.3
+
+* Add Client errors for more granular handling.
+* Send along info when a `NotAuthorizedError` is raised.
+
 ## 0.4.2
 
 * Raise an `UnhandledTypeError` and reveal the offender.
@@ -6,7 +28,8 @@
 
 ## 0.4.1
 
-* @cdmwebs screwed up the release process, so this is a tiny bump to fix. No code changes.
+* @cdmwebs screwed up the release process, so this is a tiny bump to fix. No
+  code changes.
 
 ## 0.4.0
 
@@ -18,18 +41,16 @@
 
 ## 0.2.0
 
-- Make token optional and allow specifying headers at least for enabling authentication via 'X-API-KEY' header
-, because initially implemented in 0.1.0 bearer auth isn't working.
-
-- Fix Query `build_search_term` and `build_exclude_term` to be compatible with Ruby < 2.4, analyzing value for 'Fixnum
-' class.
-
-- Fix the gem's name in gemspec to 'fulfil-io', as registered at RubyGems.
-
-- Remove Rake version constraint from gemspec.
-
-- Add Gemfile.lock to .gitignore and remove it from git-tree - it shouldn't be stored in git for a gem.
+* Make token optional and allow specifying headers at least for enabling
+  authentication via 'X-API-KEY' header , because initially implemented in
+  0.1.0 bearer auth isn't working.
+* Fix Query `build_search_term` and `build_exclude_term` to be compatible with
+  Ruby < 2.4, analyzing value for 'Fixnum ' class.
+* Fix the gem's name in gemspec to 'fulfil-io', as registered at RubyGems.
+* Remove Rake version constraint from gemspec.
+* Add Gemfile.lock to .gitignore and remove it from git-tree - it shouldn't be
+  stored in git for a gem.
 
 ## 0.1.0
 
-* Initial gem release
+* Initial gem release.

data/README.md

@@ -109,6 +109,19 @@ sale['channel'] = 4
 
 fulfil.put(model: sale_model, body: sale)
 ```
+### Interactive Reports
+
+As of v0.4.6, interactive report support exists in a basic form.
+You're able to execute reports with basic params. Responses are
+transformed to JSON structures.
+
+```ruby
+fulfil = Fulfil::Client.new
+
+report = Fulfil::Report.new(client: fulfil, report_name: 'account.tax.summary.ireport')
+
+report.execute(start_date: Date.new(2020, 12, 1), end_date: Date.new(2020, 12, 31))
+```
 
 ## Development
 

data/lib/fulfil/client.rb

@@ -10,6 +10,14 @@ module Fulfil
   OAUTH_TOKEN = ENV['FULFIL_TOKEN']
 
   class Client
+    class NotAuthorizedError < StandardError; end
+
+    class UnknownHTTPError < StandardError; end
+
+    class ConnectionError < StandardError; end
+
+    class ResponseError < StandardError; end
+
     def initialize(subdomain: SUBDOMAIN, token: OAUTH_TOKEN, headers: { 'X-API-KEY' => API_KEY }, debug: false)
       @subdomain = subdomain
       @token = token
@@ -66,13 +74,26 @@ module Fulfil
       parse(results: results)
     end
 
-    def put(model:, id:, endpoint: nil, body: {})
+    def put(model: nil, id: nil, endpoint: nil, body: {})
       uri = URI(model_url(model: model, id: id, endpoint: endpoint))
 
       result = request(verb: :put, endpoint: uri, json: body)
       parse(result: result)
     end
 
+    def delete(model:, id:)
+      uri = URI(model_url(model: model, id: id))
+
+      result = request(verb: :delete, endpoint: uri)
+      parse(result: result)
+    end
+
+    def interactive_report(endpoint:, body: nil)
+      uri = URI("#{base_url}/model/#{endpoint}")
+      result = request(verb: :put, endpoint: uri, json: body)
+      parse(result: result)
+    end
+
     private
 
     def parse(result: nil, results: [])
@@ -91,33 +112,40 @@ module Fulfil
       results.map { |result| Fulfil::ResponseParser.parse(item: result) }
     end
 
+    def domain
+      "https://#{@subdomain}.fulfil.io"
+    end
+
     def base_url
-      "https://#{@subdomain}.fulfil.io/api/v2/model"
+      [domain, 'api', 'v2'].join('/')
     end
 
     def model_url(model:, id: nil, endpoint: nil)
-      [base_url, model, id, endpoint].compact.join('/')
+      [base_url, 'model', model, id, endpoint].compact.join('/')
     end
 
-    def request(verb: :get, endpoint:, **args)
+    def request(endpoint:, verb: :get, **args)
       response = client.request(verb, endpoint, args)
 
       if response.status.ok? || response.status.created?
         response.parse
+      elsif response.code == 204
+        []
       elsif response.code == 401
-        raise StandardError, 'Not authorized'
+        error = response.parse
+        raise NotAuthorizedError, "Not authorized: #{error['error']}: #{error['error_description']}"
       else
         puts response.body.to_s
         raise Error, 'Error encountered while processing response:'
       end
     rescue HTTP::Error => e
       puts e
-      raise Error, 'Unhandled HTTP error encountered'
+      raise UnknownHTTPError, 'Unhandled HTTP error encountered'
     rescue HTTP::ConnectionError => e
       puts "Couldn't connect"
-      raise Error, "Can't connect to #{base_url}"
-    rescue HTTP::ResponseError => ex
-      raise Error, "Can't process response: #{ex}"
+      raise ConnectionError, "Can't connect to #{base_url}"
+    rescue HTTP::ResponseError => e
+      raise ResponseError, "Can't process response: #{e}"
       []
     end
 

data/lib/fulfil/interactive_report.rb

@@ -0,0 +1,33 @@
+module Fulfil
+  class InteractiveReport
+    def initialize(client:, report:)
+      @client = client
+      @report = report
+    end
+
+    def execute(start_date:, end_date:)
+      @client.interactive_report(
+        endpoint: report_url,
+        body: [{
+          start_date: serialize_date(start_date),
+          end_date: serialize_date(end_date)
+        }]
+      )
+    end
+
+    private
+
+    def report_url
+      "#{@report}/execute"
+    end
+
+    def serialize_date(date)
+      {
+        __class__: 'date',
+        year: date.year,
+        month: date.month,
+        day: date.day
+      }
+    end
+  end
+end

data/lib/fulfil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fulfil
-  VERSION = '0.4.2'
+  VERSION = '0.4.7'
 end

data/lib/fulfil.rb

@@ -1,6 +1,7 @@
 require 'fulfil/version'
 require 'fulfil/client'
 require 'fulfil/model'
+require 'fulfil/interactive_report'
 require 'fulfil/response_parser'
 
 module Fulfil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.7
 platform: ruby
 authors:
 - Chris Moore
@@ -9,22 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ files:
 - Rakefile
 - lib/fulfil.rb
 - lib/fulfil/client.rb
+- lib/fulfil/interactive_report.rb
 - lib/fulfil/model.rb
 - lib/fulfil/query.rb
 - lib/fulfil/response_parser.rb
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Interact with the Fulfil.io API