fulfil-io 0.1.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95fb599e7f5a781ab44fb3026f108c1e9952caad1f6db580989e915c2b9498f6
-  data.tar.gz: 8c56400a193b6ef8de6b60588dd793213b794fe9dc4959068402b4a0816ea4e1
+  metadata.gz: d1e18bf38ef0d20058704b439d3b633cd2a2d6c36d6eb3498764473ecdc18542
+  data.tar.gz: ef37d25469b610f6d1d7ef4e1ef41e681b514f39d147e652338464fd9a2fb977
 SHA512:
-  metadata.gz: 577b1cb9f71d27cfa533fd8dce8db1e6491f0c9ac8e798b412c6f454ac64879b6ca9e9de86d87670ece787047295d74e533f15d5de343fc0820fd9dfc6aa3a62
-  data.tar.gz: 579ccb9a08afe4c30c2ad9d8627c8f941b6b0f03da5a6397c13f3264061aae227777d7c0929c36dd08b56e53839802a8d3dbbaa2dc73ec65278cc59613501c5c
+  metadata.gz: d33dc2d8553c14c08284d6823bd0285c28bb168785e9c9885cfd9718e8233d804860348cd7ea2bcec56141de976153bd605dfabab4ce73ce958a4935abc9a17d
+  data.tar.gz: 634d58e4e9780873f4ff9c1823ab8fb1a08de125e6906ed48d50773b838015e7ea4cf8abd65ee3df26f035eab6a1131ab75a56511b3f55400e2b67f17a7b42f0

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 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.
+* Convert timedelta data types to Decimals.
+* Don't use `.present?` to check if response is a Hash.
+
+## 0.4.1
+
+* @cdmwebs screwed up the release process, so this is a tiny bump to fix. No
+  code changes.
+
+## 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
+
+* 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

@@ -9,30 +9,33 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'fulfil'
+gem 'fulfil-io', require: 'fulfil'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
-    $ gem install fulfil
+    $ gem install fulfil-io
 
 ## Usage
 
-```ruby
-require 'fulfil'
+Environment variables:
 
-FULFIL_SUBDOMAIN = 'subdomain'
-FULFIL_TOKEN = 'token'
+- FULFIL_SUBDOMAIN - required to be set.
+- FULFIL_TOKEN - required for oauth bearer authentication
+- FULFIL_API_KEY - required for authentication via the X-API-KEY request header
 
-fulfil = Fulfil::Client.new(
-  subdomain: FULFIL_SUBDOMAIN,
-  token: FULFIL_TOKEN,
-  debug: false
-)
+**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
+
+fulfil = Fulfil::Client.new # or, to enable request debugging, Fulfil::Client.new(debug: true)
 
 sale_model = Fulfil::Model.new(
   client: fulfil,
@@ -65,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

@@ -5,11 +5,22 @@ require 'logger'
 require 'fulfil/response_parser'
 
 module Fulfil
+  SUBDOMAIN = ENV['FULFIL_SUBDOMAIN']
+  API_KEY = ENV['FULFIL_API_KEY']
+  OAUTH_TOKEN = ENV['FULFIL_TOKEN']
+
   class Client
-    def initialize(subdomain:, token:, debug: false)
+    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
       @debug = debug
+      @headers = headers
+      @headers.delete('X-API-KEY') if @token
     end
 
     def find(model:, ids: [], id: nil, fields: %w[id rec_name])
@@ -38,9 +49,7 @@ module Fulfil
       parse(results: results)
     end
 
-    def search(
-      model:, domain:, offset: nil, limit: 100, sort: nil, fields: %w[id]
-    )
+    def search(model:, domain:, offset: nil, limit: 100, sort: nil, fields: %w[id])
       uri = URI("#{model_url(model: model)}/search_read")
       body = [domain, offset, limit, sort, fields]
 
@@ -48,6 +57,13 @@ 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))
 
@@ -55,9 +71,28 @@ module Fulfil
       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
 
@@ -65,8 +100,8 @@ 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)
@@ -75,26 +110,30 @@ module Fulfil
       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
         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 => e
-      raise Error, "Can't process response: #{e}"
+      raise ConnectionError, "Can't connect to #{base_url}"
+    rescue HTTP::ResponseError => ex
+      raise ResponseError, "Can't process response: #{ex}"
       []
     end
 
     def client
-      @client ||=
-        HTTP.persistent(base_url).auth("Bearer #{@token}")
-            .use(logging: @debug ? { logger: Logger.new(STDOUT) } : {})
+      return @client if defined?(@client)
+
+      @client = HTTP.persistent(base_url).use(logging: @debug ? { logger: Logger.new(STDOUT) } : {})
+      @client = @client.auth("Bearer #{@token}") if @token
+      @client = @client.headers(@headers)
+      @client
     end
   end
 end

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/query.rb

@@ -68,7 +68,7 @@ module Fulfil
       case value.class.name
       when 'Array'
         [[key, 'in', value]]
-      when 'Integer'
+      when 'Fixnum', 'Integer'
         [[key, '=', value]]
       when 'Range'
         [
@@ -96,7 +96,7 @@ module Fulfil
       case value.class.name
       when 'Array'
         [[key, 'not in', value]]
-      when 'Integer'
+      when 'Fixnum', 'Integer'
         [[key, '!=', value]]
       when 'Range'
         [
@@ -112,4 +112,4 @@ module Fulfil
       end
     end
   end
-end
+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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fulfil
-  VERSION = "0.1.0"
+  VERSION = '0.4.3'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Chris Moore
 - Kat Fairbanks
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -85,37 +85,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '0'
+description:
 email:
 - chris@knowndecimal.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/authenticate
-- bin/console
-- bin/setup
-- fulfil.gemspec
 - lib/fulfil.rb
 - lib/fulfil/client.rb
 - lib/fulfil/model.rb
@@ -126,7 +119,7 @@ homepage: https://github.com/knowndecimal/fulfil
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -142,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Interact with the Fulfil.io API
 test_files: []

data/.circleci/config.yml

@@ -1,43 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.6.0
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            gem install bundler --no-document
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      # run tests!
-      - run:
-          name: run tests
-          environment:
-            TESTOPTS: "--ci-dir=/tmp/test-results"
-          command: |
-            mkdir /tmp/test-results
-            bundle exec rake test
-
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at chris@cdmwebs.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fulfil (0.1.0)
-      http
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ansi (1.5.0)
-    builder (3.2.3)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    faraday (0.17.1)
-      multipart-post (>= 1.2, < 3)
-    http (4.1.1)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    jwt (2.2.1)
-    minitest (5.11.3)
-    minitest-reporters (1.3.6)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    multi_json (1.14.1)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    oauth2 (1.4.2)
-      faraday (>= 0.8, < 2.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    public_suffix (3.1.1)
-    rack (2.0.7)
-    rake (10.5.0)
-    ruby-progressbar (1.10.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  fulfil!
-  minitest (~> 5.0)
-  minitest-reporters (~> 1.3)
-  oauth2 (~> 1.4)
-  rake (~> 10.0)
-
-BUNDLED WITH
-   2.1.4

data/bin/authenticate

@@ -1,54 +0,0 @@
-#!/usr/bin/env ruby
-
-# frozen_string_literal: true
-
-require 'bundler'
-Bundler.setup(:default, :development)
-
-require 'oauth2'
-require 'fulfil'
-
-def get_token
-  client_id = ENV.fetch('CLIENT_ID')
-  client_secret = ENV.fetch('CLIENT_SECRET')
-  subdomain = ENV.fetch('SUBDOMAIN')
-
-  base_url = "https://#{subdomain}.fulfil.io" # "oauth/authorize"
-
-  client = OAuth2::Client.new(client_id, client_secret, site: base_url)
-  authorize_url = client.auth_code.authorize_url(
-    redirect_uri: 'urn:ietf:wg:oauth:2.0:oob',
-    scope: ['sale.channel:read'].join(','),
-    access_type: 'offline_access'
-  )
-
-  output 'Open this URL:'
-  system %x[echo "#{authorize_url.to_s}" | pbcopy]
-  output authorize_url.to_s
-
-  output 'Copy the generated token. Paste it here:'
-
-  auth_token = gets.chomp
-  output ''
-  token = client.auth_code.get_token(auth_token)
-
-  output 'Results:'
-  pp token.to_hash
-  output ''
-
-  output 'Offline access token:'
-  output token.to_hash.dig('offline_access_token')
-end
-
-def output(text, lines: 2)
-  puts text
-  puts "\n" * lines
-end
-
-def fulfil
-  @fulfil ||= Fulfil::Client.new(
-    subdomain: ENV.fetch('SUBDOMAIN'), token: ENV.fetch('TOKEN')
-  )
-end
-
-get_token

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'fulfil'
-
-def fulfil
-  @fulfil ||= Fulfil::Client.new(
-    subdomain: ENV.fetch('SUBDOMAIN'), token: ENV.fetch('TOKEN')
-  )
-end
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/fulfil.gemspec

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'fulfil/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'fulfil-io'
-  spec.version       = Fulfil::VERSION
-  spec.authors       = ['Chris Moore', 'Kat Fairbanks']
-  spec.email         = ['chris@knowndecimal.com']
-
-  spec.summary       = 'Interact with the Fulfil.io API'
-  spec.homepage      = 'https://github.com/knowndecimal/fulfil'
-  spec.license       = 'MIT'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'http'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'minitest-ci', '~> 3.4' if ENV['CI']
-  spec.add_development_dependency 'minitest-reporters', '~> 1.3'
-  spec.add_development_dependency 'oauth2', '~> 1.4'
-  spec.add_development_dependency 'rake', '~> 10.0'
-end