fulfil-io 0.2.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d19d908e32866d5bb5f96696cc90f59724e7654374c34d49f49e376a117d9c29
-  data.tar.gz: ba380e30001c2409f404a36ea6335a8762ec993b45b431c08c5b5d703172e550
+  metadata.gz: 7be62208f07b3dabac64da70cd97d7ef5d5e513a363d830206ffc6ad25ebffc5
+  data.tar.gz: ddba02ac333a132dcce3886f51b35865d58f4a999adba7f1f10a9ee3cec5e344
 SHA512:
-  metadata.gz: 7d60b09fcfb88fcf29e160d1c6acef304ce57134dff910f881166ddb5dac88c83a697e65132ca59778ec47695f5f346269154ac76b120d201781221128bf47a8
-  data.tar.gz: 7db725e451c38016cd63fda0ccbe46b9e1257236f660c021f3f649c9ca4dad3a80fe652143e526e79f29e0ea6f60453d9e50f43883292490653a64d4d8661760
+  metadata.gz: 02e3e8e5ae922598b1971b96ba26ba2a17c6f05cc4c2ea319bc0e3d69b75fdfc9115ee860b43d4c2965e292f80470ea17d9c07819d0d30aef03610fa1611ae85
+  data.tar.gz: 000740a6f8cff338590329900671bf297acfd41c83f38c5197bac711706ac934b37e39e55ec5683575b6e9ffbfead3f73b6d766afb4b0d8a5e357aa6db9c6c4b

data/CHANGELOG.md

@@ -1,17 +1,43 @@
-## 0.2.0
+## 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
 
-- 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.
+* Raise an `UnhandledTypeError` and reveal the offender.
+* Convert timedelta data types to Decimals.
+* Don't use `.present?` to check if response is a Hash.
 
-- Fix Query `build_search_term` and `build_exclude_term` to be compatible with Ruby < 2.4, analyzing value for 'Fixnum
-' class.
+## 0.4.1
 
-- Fix the gem's name in gemspec to 'fulfil-io', as registered at RubyGems.
+* @cdmwebs screwed up the release process, so this is a tiny bump to fix. No
+  code changes.
 
-- Remove Rake version constraint from gemspec.
+## 0.4.0
+
+* Add `Client#count` and `Model#count`.
+
+## 0.3.0
+
+* Add basic write support via `Fulfil::Client#post` and `Fulfil::Client#put`.
+
+## 0.2.0
 
-- 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

@@ -28,9 +28,9 @@ Environment variables:
 - FULFIL_TOKEN - required for oauth bearer authentication
 - FULFIL_API_KEY - required for authentication via the X-API-KEY request header
 
-###Note: 
-
-When FULFIL_TOKEN is present, the FULFIL_API_KEY will be ignored. So, if oauth doesn't work, returning an Unauthorized error, to use the FULFIL_API_KEY, the FULFIL_TOKEN shouldn't be specified.
+**Note:** When FULFIL_TOKEN is present, the FULFIL_API_KEY will be ignored. So,
+if oauth doesn't work, returning an Unauthorized error, to use the
+FULFIL_API_KEY, the FULFIL_TOKEN shouldn't be specified.
 
 ```ruby
 require 'fulfil' # this is necessary only in case of running without bundler
@@ -68,6 +68,48 @@ pp sales
 #   "rec_name"=>""}]
 ```
 
+### Count
+
+```ruby
+client = Fulfil::Client.new
+model = Fulfil::Model.new(client: client, model_name: 'stock.shipment.out')
+model.count(domain: [['shipping_batch.state', '=', 'open']])
+
+# Returns 7440
+```
+
+### Writing
+
+As of v0.3.0, we've added very basic support for creates and updates via
+`Fulfil::Client#post` and `Fulfil::Client#put`.
+
+*Create Example*
+
+```ruby
+fulfil = Fulfil::Client.new
+
+sale_model = Fulfil::Model.new(client: fulfil, model_name: 'sale.sale')
+
+sale = {
+  # Full Sale attributes here
+}
+
+fulfil.post(model: sale_model, body: sale)
+```
+
+*Update Example*
+
+```ruby
+fulfil = Fulfil::Client.new
+
+sale_model = Fulfil::Model.new(client: fulfil, model_name: 'sale.sale')
+sale = sale_model.find(id: 1234)
+
+sale['channel'] = 4
+
+fulfil.put(model: sale_model, body: sale)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/fulfil/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'http'
 require 'logger'
 require 'fulfil/response_parser'
@@ -8,6 +10,11 @@ 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
@@ -50,9 +57,42 @@ module Fulfil
       parse(results: results)
     end
 
+    def count(model:, domain:)
+      uri = URI("#{model_url(model: model)}/search_count")
+      body = [domain]
+
+      request(verb: :put, endpoint: uri, json: body)
+    end
+
+    def post(model:, body: {})
+      uri = URI(model_url(model: model))
+
+      results = request(verb: :post, endpoint: uri, json: body)
+      parse(results: results)
+    end
+
+    def put(model:, id:, 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
+
     private
 
     def parse(result: nil, results: [])
+      if result
+        parse_single(result: result)
+      else
+        parse_multiple(results: results)
+      end
+    end
+
+    def parse_single(result:)
+      Fulfil::ResponseParser.parse(item: result)
+    end
+
+    def parse_multiple(results:)
       results.map { |result| Fulfil::ResponseParser.parse(item: result) }
     end
 
@@ -60,26 +100,31 @@ module Fulfil
       "https://#{@subdomain}.fulfil.io/api/v2/model"
     end
 
-    def model_url(model:)
-      [base_url, model].join('/')
+    def model_url(model:, id: nil, endpoint: nil)
+      [base_url, model, id, endpoint].compact.join('/')
     end
 
     def request(verb: :get, endpoint:, **args)
       response = client.request(verb, endpoint, args)
 
-      if response.status.ok?
+      if response.status.ok? || response.status.created?
         response.parse
       elsif response.code == 401
-        raise StandardError, "Not authorized"
+        error = response.parse
+        raise NotAuthorizedError, "Not authorized: #{error['error']}: #{error['error_description']}"
       else
-        pp response.parse
-        raise StandardError, "Invalid response"
+        puts response.body.to_s
+        raise Error, 'Error encountered while processing response:'
       end
-    rescue HTTP::ConnectionError => ex
+    rescue HTTP::Error => e
+      puts e
+      raise UnknownHTTPError, 'Unhandled HTTP error encountered'
+    rescue HTTP::ConnectionError => e
       puts "Couldn't connect"
-      raise Error, "Can't connect to #{base_url}"
+      raise ConnectionError, "Can't connect to #{base_url}"
     rescue HTTP::ResponseError => ex
-      raise Error, "Can't process response: #{ex}"
+      raise ResponseError, "Can't process response: #{ex}"
+      []
     end
 
     def client

data/lib/fulfil/model.rb

@@ -36,6 +36,10 @@ module Fulfil
       )
     end
 
+    def count(domain:)
+      @client.count(model: model_name, domain: domain)
+    end
+
     def all
       search(domain: query)
     end

data/lib/fulfil/response_parser.rb

@@ -1,5 +1,14 @@
 module Fulfil
   module ResponseParser
+    class UnhandledTypeError < StandardError
+      attr_reader :value
+
+      def initialize(msg, value)
+        @value = value
+        super(msg)
+      end
+    end
+
     # Handle value objects, for example:
     #
     # "order_date": {
@@ -19,10 +28,13 @@ module Fulfil
       when 'datetime'
         time = value.dig('iso_string')
         DateTime.parse(time)
-      when 'Decimal'
+      when 'Decimal', 'timedelta'
         value.dig('decimal').to_f
       else
-        raise UnhandledTypeError, value
+        raise UnhandledTypeError.new(
+          "received a value that we don't know how to handle: #{json_class}",
+          json_class
+        )
       end
     end
 

data/lib/fulfil/version.rb

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

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Chris Moore
 - Kat Fairbanks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-05-20 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
@@ -95,7 +95,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - chris@knowndecimal.com
 executables: []
@@ -119,7 +119,7 @@ homepage: https://github.com/knowndecimal/fulfil
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Interact with the Fulfil.io API
 test_files: []