duodealer_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4265e6139d66455a7dbd091d56cd085f2e7ec337721256678771c408486f657
+  data.tar.gz: f145162ae13aeb3f5faf148252b49e5e8f0e3605d95fa96880ba396b4847075d
+SHA512:
+  metadata.gz: 92f7734605809972f78d8845dc209a424e86327488d05edaf716dca9873f1e6786d1f2cea700a1cbb9e735acffec5871d4ae7e043ad68c7fd5f9128c75a836b4
+  data.tar.gz: af7dbc96a95bc64d76ab7aeb72cc977b82a44aabb6f96e8a38fc999cc38ba642142fb7cedbff51dc9f43368ef0cee847898e41c5e154ac33560f16f5866d8d7a

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,13 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+doc
+pkg
+.ruby-version
+*.lock
+*.gem
+.idea
+.dev/
+.bundle/
+vendor/

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://duodealer.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Rails:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+sudo: false
+
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.2
+
+gemfile:
+  - Gemfile_ar41
+  - Gemfile_ar50
+  - Gemfile_ar51
+  - Gemfile_ar_master
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: 2.4.6
+      gemfile: Gemfile_ar_master
+    - rvm: 2.5.5
+      gemfile: Gemfile_ar_master
+    - rvm: 2.6.2
+      gemfile: Gemfile_ar_master

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "~> 5.1"

data/Gemfile_ar41

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "4.1.0"

data/Gemfile_ar50

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "5.0.0"

data/Gemfile_ar51

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "5.1.0"

data/Gemfile_ar_master

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'activeresource', git: 'git://github.com/rails/activeresource'

data/RELEASING

@@ -0,0 +1,13 @@
+Releasing DuodealerAPI
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Update the version of DuodealerAPI in lib/duodealer_api/version.rb
+3. Add a CHANGELOG entry for the new release
+4. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+5. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z REV
+6. Push out the changes
+  $ git push
+7. Push out the tags
+  $ git push --tags
+8. Publish the gem using Shipit

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.warning = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "duodealer_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :docker do
+  cmd = "docker-compose up -d && docker exec -i -t duodealer_api bash"
+  exec(cmd, err: File::NULL)
+end

data/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.5'
+services:
+  api:
+    container_name: duodealer_api
+    image: ruby:2.6
+    working_dir: /duodealer_api
+    volumes:
+      - .:/duodealer_api
+      - bundle:/usr/local/bundle
+    command: bash -c "bundle install && tail -f /dev/null"
+
+volumes:
+  bundle:

data/docs/graphql.md

@@ -0,0 +1,191 @@
+# GraphQL client
+
+The `duodealer_api` gem includes a full featured GraphQL client to interact with
+DuoDealer's [GraphQL Admin API](https://help.duodealer.com/en/api/graphql-admin-api).
+GitHub's [graphql-client](https://github.com/github/graphql-client) is used as
+the underlying client and this library integrates it with our existing
+session, authentication, and API versioning features.
+
+## Example
+
+```ruby
+client = DuodealerAPI::GraphQL.client
+
+SHOP_NAME_QUERY = client.parse <<-'GRAPHQL'
+  {
+    shop {
+      name
+    }
+  }
+GRAPHQL
+
+result = client.query(SHOP_NAME_QUERY)
+result.data.shop.name
+```
+
+* [Getting started](#getting-started)
+* [Rails integration](#rails-integration)
+* [API versioning](#api-versioning)
+* [Initialization process](#initialization-process)
+* [Migration guide](#migration-guide)
+
+## Getting started
+
+1. [Dump the schema](#dump-the-schema)
+2. [Configure session/authencation](#sessions-and-authentication)
+3. [Make queries](#make-queries)
+
+### Dump the schema
+One of the main benefits of GraphQL is its [schema and type system](https://graphql.org/learn/schema/)
+which enables tools like graphql-client to ensure your queries are valid in development.
+
+So the first step in making GraphQL queries is having a local JSON file of DuoDealer's Admin schema.
+This gem provides a `duodealer_api:graphql:dump` Rake task to make it as easy as possible:
+
+```bash
+$ rake duodealer_api:graphql:dump SHOP_URL="https://API_KEY:PASSWORD@SHOP_NAME.duodealer.com" API_VERSION=2020-01
+```
+
+If successful `db/duodealer_graphql_schemas/2020-01.json` will be created.
+
+You can either use private app authentication or an OAuth access token. Run `rake duodealer_api:graphql:dump`
+to see full usage details.
+
+If you're using duodealer_api in a Rails app, the default location for schema files is `db/duodealer_graphql_schemas`.
+For non-Rails applications, the default is `duodealer_graphql_schemas` in your project root.
+
+The schema path location can be changed via `DuodealerAPI::GraphQL.schema_location`:
+
+```ruby
+DuodealerAPI::GraphQL.schema_location = 'assets/schemas'
+```
+
+#### Updating schemas
+Each time you want to use a new API version, or update an existing one
+(such as the `unstable` version), simply run the Rake task again to overwrite the file.
+
+### Sessions and authentication
+The GraphQL client is designed to be integrated with the rest of duodealer_api so
+all its features such as sessions, authentication, and API versioning work the
+exact same.
+
+If you've already been using the duodealer_api gem in your application to make
+REST API calls then no other configuration is necessary.
+
+Steps 1-5 of our main [Getting started](https://gitlab.com/duodealer/duodealer_api#getting-started)
+section still apply for the GraphQL client as well.
+
+### Make queries
+Now that you've dumped a schema file and configured an authenticated session, you can make GraphQL API requests.
+graphql-client encourages all queries to be defined statically as constants:
+
+```ruby
+SHOP_NAME_QUERY = DuodealerAPI::GraphQL.client.parse <<-'GRAPHQL'
+  {
+    shop {
+      name
+    }
+  }
+GRAPHQL
+
+result = DuodealerAPI::GraphQL.client.query(SHOP_NAME_QUERY)
+result.data.shop.name
+```
+
+But we've also enabled its `allow_dynamic_queries` option if you prefer:
+
+```ruby
+query = DuodealerAPI::GraphQL.client.parse <<-'GRAPHQL'
+  {
+    shop {
+      name
+    }
+  }
+GRAPHQL
+
+result = DuodealerAPI::GraphQL.client.query(query)
+result.data.shop.name
+```
+
+See the [graphql-client documentation](https://github.com/github/graphql-client#defining-queries)
+for more details on defining and executing queries.
+
+## Rails integration
+`DuodealerAPI::GraphQL` integrates with Rails to automatically do the following:
+
+* load the `duodealer_api:graphql:dump` Rake task
+* set the `schema_location` to be in the `db` directory in your Rails root
+* initialize clients in the Rails app initializer phase
+
+## API versioning
+`DuodealerAPI::GraphQL` is version aware and lets you easily make queries to multiple
+API versions through version specific clients if need be.
+
+If you have multiple clients and need to be explicit you can specify the version parameter:
+
+```ruby
+DuodealerAPI::GraphQL.client # defaults to the client using DuodealerAPI::Base.api_version
+DuodealerAPI::GraphQL.client('unstable')
+```
+
+## Initialization process
+`DuodealerAPI::GraphQL` is a thin integration layer which initializes `GraphQL::Client`s
+from local schema files.
+
+`DuodealerAPI::GraphQL.initialize_clients` scans `DuodealerAPI::GraphQL.schema_location`
+and creates a client for each version specific schema file found.
+
+This happens automatically in a Rails application due to our [integration](#rails-integration).
+For non-Rails applications, ensure you call `DuodealerAPI::GraphQL.initialize_clients`
+during your boot process.
+
+The goal is to have all clients created at boot so there's no schema loading,
+parsing, or client instantiation done during runtime when your app serves a request.
+
+## Migration guide
+Prior to duodealer_api v9.0 the GraphQL client implementation was limited and almost
+unusable due to the client making dynamic introspection queries to Duo Dealer's API.
+This was not only very slow but also led to unbounded memory growth.
+
+There are two steps to migrate to the new client:
+1. [Dump a local schema file](#dump-the-schema)
+2. [Migrate `client` usage](#migrate-usage)
+
+### Migrate usage
+
+Previously a client was initialized with `DuodealerAPI::GraphQL.new`:
+```ruby
+client = DuodealerAPI::GraphQL.new
+
+SHOP_NAME_QUERY = client.parse <<-'GRAPHQL'
+  {
+    shop {
+      name
+    }
+  }
+GRAPHQL
+
+result = client.query(SHOP_NAME_QUERY)
+result.data.shop.name
+```
+
+Now there's no need to initialize a client so all references to
+`DuodealerAPI::GraphQL.new` should be removed and instead the client is called
+via `DuodealerAPI::GraphQL.client`:
+
+```ruby
+client = DuodealerAPI::GraphQL.client
+
+SHOP_NAME_QUERY = client.parse <<-'GRAPHQL'
+  {
+    shop {
+      name
+    }
+  }
+GRAPHQL
+
+result = client.query(SHOP_NAME_QUERY)
+result.data.shop.name
+```
+
+See [making queries](#making-queries) for more usage details.

data/duodealer_api.gemspec

@@ -0,0 +1,38 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "duodealer_api/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{duodealer_api}
+  s.version = DuodealerAPI::VERSION
+  s.author = "Eric Raio"
+
+  s.summary = %q{The Duo Dealer API gem is a lightweight gem for accessing the Duo Dealer admin GraphQL web services}
+  s.description = %q{The Duo Dealer API gem allows Ruby developers to programmatically access the admin section of Duo Dealer stores. The API is implemented as JSON or XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation.}
+  s.email = %q{careers@duodealer.com}
+  s.homepage = %q{http://www.duodealer.com/partners/apps}
+
+  s.extra_rdoc_files = []
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.summary = %q{DuodealerAPI is a lightweight gem for accessing the Duo Dealer admin GraphQL web services}
+  s.license = "MIT"
+
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency("railties", "~> 6.0.2.1")
+  s.add_runtime_dependency("activeresource", ">= 4.1.0", "< 6.0.0")
+  s.add_runtime_dependency("rack")
+  s.add_runtime_dependency("graphql-client")
+
+  s.add_development_dependency("mocha", ">= 0.9.8")
+  s.add_development_dependency("webmock")
+  s.add_development_dependency("minitest", ">= 4.0")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("timecop")
+  s.add_development_dependency("rubocop")
+  s.add_development_dependency("pry")
+  s.add_development_dependency("pry-byebug")
+end

data/lib/active_resource/connection_ext.rb

@@ -0,0 +1,10 @@
+require 'duodealer_api/connection'
+
+module ActiveResource
+  class Connection
+    attr_reader :response
+
+    prepend DuodealerAPI::Connection::ResponseCapture
+    prepend DuodealerAPI::Connection::RequestNotification
+  end
+end

data/lib/active_resource/detailed_log_subscriber.rb

@@ -0,0 +1,52 @@
+module ActiveResource
+  class DetailedLogSubscriber < ActiveSupport::LogSubscriber
+    VERSION_EOL_WARNING_HEADER = 'x-duodealer-api-version-warning'
+    VERSION_DEPRECATION_HEADER = 'x-duodealer-api-deprecated-reason'
+    def request(event)
+      log_request_response_details(event)
+      warn_on_deprecated_header_or_version_eol_header(event)
+    end
+
+    def logger
+      ActiveResource::Base.logger
+    end
+
+    private
+
+    def log_request_response_details(event)
+      data = event.payload[:data]
+      headers = data.extract_options!
+      request_body = data.first
+
+      info "Request:\n#{request_body}" if request_body
+      info "Headers: #{headers.inspect}"
+      info "Response:\n#{event.payload[:response].body}"
+    end
+
+    def warn_on_deprecated_header_or_version_eol_header(event)
+      payload = event.payload
+
+      payload[:response].each do |header_name, header_value|
+        case header_name.downcase
+        when VERSION_DEPRECATION_HEADER
+          warning_message = <<-MSG
+          [DEPRECATED] DuodealerAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call made
+          use of a deprecated endpoint, behaviour, or parameter. See #{header_value} for more details.
+          MSG
+
+          warn warning_message
+
+        when VERSION_EOL_WARNING_HEADER
+          warning_message = <<-MSG
+          [API Version Warning] DuodealerAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call used
+          an API version that is unsupported or will become unsupported within 30 days. See #{header_value} for more details.
+          MSG
+
+          warn warning_message
+        end
+      end
+    end
+  end
+end
+
+ActiveResource::DetailedLogSubscriber.attach_to :active_resource_detailed