duodealer_api 1.0.0

data/lib/duodealer_api/graphql/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'rails/railtie'
+
+module DuodealerAPI
+  module GraphQL
+    class Railtie < Rails::Railtie
+      initializer 'duodealer_api.initialize_graphql_clients' do |app|
+        DuodealerAPI::GraphQL.schema_location = app.root.join('db', DuodealerAPI::GraphQL.schema_location)
+        DuodealerAPI::GraphQL.initialize_clients
+      end
+
+      rake_tasks do
+        load 'duodealer_api/graphql/task.rake'
+      end
+    end
+  end
+end

data/lib/duodealer_api/graphql/task.rake

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+require 'fileutils'
+
+namespace :duodealer_api do
+  namespace :graphql do
+    desc 'Dumps a local JSON schema file of the Duo Dealer Admin API'
+    task :dump do
+      usage = <<~USAGE
+
+        Usage: rake duodealer_api:graphql:dump [<args>]
+
+        Dumps a local JSON schema file of the Duo Dealer Admin API. The schema is specific to an
+        API version and authentication is required (either OAuth or private app).
+
+        Dump the schema file for the 2020-01 API version using private app authentication:
+          $ rake duodealer_api:graphql:dump SHOP_URL="https://API_KEY:PASSWORD@SHOP_NAME.duodealer.com" API_VERSION=2020-01
+
+        Dump the schema file for the unstable API version using an OAuth access token:
+          $ rake duodealer_api:graphql:dump SHOP_DOMAIN=SHOP_NAME.duodealer.com ACCESS_TOKEN=abc API_VERSION=unstable
+
+        Arguments:
+          ACCESS_TOKEN  OAuth access token (shop specific)
+          API_VERSION   API version handle [example: 2020-01]
+          SHOP_DOMAIN   Shop domain (without path) [example: SHOP_NAME.duodealer.com]
+          SHOP_URL      Shop URL for private apps [example: https://API_KEY:PASSWORD@SHOP_NAME.duodealer.com]
+      USAGE
+
+      access_token = ENV['ACCESS_TOKEN'] || ENV['access_token']
+      api_version = ENV['API_VERSION'] || ENV['api_version']
+      shop_url = ENV['SHOP_URL'] || ENV['shop_url']
+      shop_domain = ENV['SHOP_DOMAIN'] || ENV['shop_domain']
+
+      unless access_token || api_version || shop_url || shop_domain
+        puts usage
+        exit(1)
+      end
+
+      unless shop_url || shop_domain
+        puts 'Error: either SHOP_DOMAIN or SHOP_URL is required for authentication'
+        puts usage
+        exit(1)
+      end
+
+      if shop_url && shop_domain
+        puts 'Error: SHOP_DOMAIN and SHOP_URL cannot be used together. Use one or the other for authentication.'
+        puts usage
+        exit(1)
+      end
+
+      if shop_domain && !access_token
+        puts 'Error: ACCESS_TOKEN required when SHOP_DOMAIN is used'
+        puts usage
+        exit(1)
+      end
+
+      unless api_version
+        puts 'Error: API_VERSION required. Example: 2020-01'
+        puts usage
+        exit(1)
+      end
+
+      Rake::Task['environment'].invoke if Rake::Task.task_defined?('environment')
+
+      Duodealer::ApiVersion.fetch_known_versions
+      DuodealerAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
+
+      duodealer_session = DuodealerAPI::Session.new(domain: shop_domain, token: access_token, api_version: api_version)
+      DuodealerAPI::Base.activate_session(duodealer_session)
+
+      if shop_url
+        DuodealerAPI::Base.site = shop_url
+      end
+
+      puts "Fetching schema for #{DuodealerAPI::Base.api_version.handle} API version..."
+
+      client = DuodealerAPI::GraphQL::HTTPClient.new(DuodealerAPI::Base.api_version)
+      document = GraphQL.parse('{ __schema { queryType { name } } }')
+      response = client.execute(document: document).to_h
+
+      unless response['data'].present?
+        puts "Error: failed to query the API."
+        puts "Response: #{response}"
+        puts 'Ensure your SHOP_DOMAIN or SHOP_URL are valid and you have valid authentication credentials.'
+        puts usage
+        exit(1)
+      end
+
+      schema_location = DuodealerAPI::GraphQL.schema_location
+      FileUtils.mkdir_p(schema_location) unless Dir.exist?(schema_location)
+
+      schema_file = schema_location.join("#{api_version}.json")
+      GraphQL::Client.dump_schema(client, schema_file.to_s)
+
+      puts "Wrote file #{schema_file}"
+    end
+  end
+end

data/lib/duodealer_api/limits.rb

@@ -0,0 +1,76 @@
+module DuodealerAPI
+  module Limits
+    class LimitUnavailable < StandardError; end
+
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      # Takes form <call count>/<bucket size>
+      # See https://help.duodealer.com/en/api/getting-started/api-call-limit
+      # Eg: 2/40
+      CREDIT_LIMIT_HEADER_PARAM = {
+        shop: 'X-DuoDealer-Shop-Api-Call-Limit',
+      }
+
+      ##
+      # How many more API calls can I make?
+      # @return {Integer}
+      #
+      def credit_left
+        credit_limit(:shop) - credit_used(:shop)
+      end
+      alias_method :available_calls, :credit_left
+
+      ##
+      # Have I reached my API call limit?
+      # @return {Boolean}
+      #
+      def credit_maxed?
+        credit_left <= 0
+      end
+      alias_method :maxed?, :credit_maxed?
+
+      ##
+      # How many total API calls can I make?
+      # NOTE: subtracting 1 from credit_limit because I think DuodealerAPI cuts off at 299 or shop limits.
+      # @param {Symbol} scope [:shop]
+      # @return {Integer}
+      #
+      def credit_limit(scope=:shop)
+        api_credit_limit_param(scope).pop.to_i - 1
+      end
+      alias_method :call_limit, :credit_limit
+
+      ##
+      # How many API calls have I made?
+      # @param {Symbol} scope [:shop]
+      # @return {Integer}
+      #
+      def credit_used(scope=:shop)
+        api_credit_limit_param(scope).shift.to_i
+      end
+      alias_method :call_count, :credit_used
+
+      ##
+      # @return {HTTPResonse}
+      #
+      def response
+        Shop.current unless DuodealerAPI::Base.connection.response
+        DuodealerAPI::Base.connection.response
+      end
+
+      private
+
+      ##
+      # @return {Array}
+      #
+      def api_credit_limit_param(scope)
+        header = response[CREDIT_LIMIT_HEADER_PARAM[scope]]
+        raise LimitUnavailable unless header
+        header.split('/')
+      end
+    end
+  end
+end

data/lib/duodealer_api/message_enricher.rb

@@ -0,0 +1,23 @@
+module DuodealerAPI
+  class MessageEnricher < SimpleDelegator
+    def message
+      return super unless (400...500).include?(code.to_i)
+
+      @_cached_message ||= begin
+        detailed_error = begin
+          parsed_body = JSON.parse(body)
+
+          if parsed_body['error']
+            parsed_body['error'].to_s
+          elsif parsed_body['errors']
+            Array(parsed_body['errors']).join('; ')
+          end
+        rescue JSON::ParserError
+          nil
+        end
+
+        detailed_error.present? ? "#{super} (#{detailed_error})" : super
+      end
+    end
+  end
+end

data/lib/duodealer_api/meta.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class Meta < ActiveResource::Base
+    self.site = "https://app.duodealer.com/services/"
+    self.element_name = 'api'
+    self.primary_key = :handle
+    self.timeout = 5
+
+    def self.admin_versions
+      all.find { |api| api.handle = :admin }.versions
+    end
+  end
+end
+

data/lib/duodealer_api/metafields.rb

@@ -0,0 +1,20 @@
+module DuodealerAPI
+  module Metafields
+    def metafields(**options)
+      options.merge! resource: self.class.collection_name, resource_id: id
+
+      Metafield.find :all, params: options
+    end
+
+    def add_metafield(metafield)
+      raise ArgumentError, "You can only add metafields to resource that has been saved" if new?
+
+      metafield.prefix_options = {
+        :resource => self.class.collection_name,
+        :resource_id => id
+      }
+      metafield.save
+      metafield
+    end
+  end
+end

data/lib/duodealer_api/paginated_collection.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class PaginatedCollection < ActiveResource::Collection
+    module CollectionPagination
+      def initialize(args)
+        @next_url = pagination_link_headers.next_link&.url&.to_s
+        @previous_url = pagination_link_headers.previous_link&.url&.to_s
+        super(args)
+      end
+
+      def next_page?
+        ensure_available
+        @next_url.present?
+      end
+
+      def previous_page?
+        ensure_available
+        @previous_url.present?
+      end
+
+      def fetch_next_page
+        fetch_page(@next_url)
+      end
+
+      def fetch_previous_page
+        fetch_page(@previous_url)
+      end
+
+      def next_page_info
+        extract_page_info(@next_url)
+      end
+
+      def previous_page_info
+        extract_page_info(@previous_url)
+      end
+
+      private
+
+      AVAILABLE_IN_VERSION = DuodealerAPI::ApiVersion.find_version('2019-10')
+      AVAILABLE_IN_VERSION_EARLY = DuodealerAPI::ApiVersion.find_version('2019-07')
+
+      def fetch_page(url)
+        ensure_available
+        return [] unless url.present?
+
+        resource_class.all(from: url)
+      end
+
+      def pagination_link_headers
+        @pagination_link_headers ||= DuodealerAPI::PaginationLinkHeaders.new(
+          DuodealerAPI::Base.connection.response["Link"]
+        )
+      end
+
+      def ensure_available
+        return if DuodealerAPI::Base.api_version >= AVAILABLE_IN_VERSION
+        return if DuodealerAPI::Base.api_version >= AVAILABLE_IN_VERSION_EARLY && resource_class.early_july_pagination?
+        raise NotImplementedError
+      end
+
+      def extract_page_info(url)
+        CGI.escape(Rack::Utils.parse_query(URI(url).query)['page_info']) if url.present?
+      end
+    end
+
+    include CollectionPagination
+  end
+end

data/lib/duodealer_api/pagination_link_headers.rb

@@ -0,0 +1,33 @@
+module DuodealerAPI
+  class InvalidPaginationLinksError < StandardError; end
+
+  class PaginationLinkHeaders
+    LinkHeader = Struct.new(:url, :rel)
+    attr_reader :previous_link, :next_link
+
+    def initialize(link_header)
+      links = parse_link_header(link_header)
+      @previous_link = links.find { |link| link.rel == :previous }
+      @next_link = links.find { |link| link.rel == :next }
+
+      self
+    end
+
+    private
+
+    def parse_link_header(link_header)
+      return [] unless link_header.present?
+      links = link_header.split(',')
+      links.map do |link|
+        parts = link.split('; ')
+        raise DuodealerAPI::InvalidPaginationLinksError.new("Invalid link header: url and rel expected") unless parts.length == 2
+
+        url = parts[0][/<(.*)>/, 1]
+        rel = parts[1][/rel="(.*)"/, 1]&.to_sym
+
+        url = URI.parse(url)
+        LinkHeader.new(url, rel)
+      end
+    end
+  end
+end

data/lib/duodealer_api/resources.rb

@@ -0,0 +1,3 @@
+require 'duodealer_api/resources/base'
+require 'duodealer_api/resources/array_base'
+Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) }

data/lib/duodealer_api/resources/abandoned_checkout.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class AbandonedCheckout < Base
+    self.element_name = "checkout"
+  end
+end

data/lib/duodealer_api/resources/access_scope.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module DuodealerAPI
+  class AccessScope < Base
+    class << self
+      def prefix(_options={})
+        '/admin/oauth/'
+      end
+    end
+  end
+end

data/lib/duodealer_api/resources/access_token.rb

@@ -0,0 +1,8 @@
+module DuodealerAPI
+  class AccessToken < Base
+    def self.delegate(access_scope, expires_in = nil)
+      resource = post(:delegate, delegate_access_scope: access_scope, expires_in: expires_in)
+      instantiate_record(format.decode(resource.body), {})
+    end
+  end
+end

data/lib/duodealer_api/resources/address.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class Address < Base
+  end
+end

data/lib/duodealer_api/resources/announcement.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class Announcement < Base
+  end
+end

data/lib/duodealer_api/resources/api_permission.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class ApiPermission < Base
+    def self.destroy
+      delete(:current)
+    end
+  end
+end

data/lib/duodealer_api/resources/application_charge.rb

@@ -0,0 +1,15 @@
+module DuodealerAPI
+  class ApplicationCharge < Base
+    undef_method :test
+
+    class << self
+      [:pending, :expired, :accepted, :declined].each do |status|
+        define_method(status) { (all || []).select { |c| c.status == status.to_s } }
+      end
+    end
+
+    def activate
+      load_attributes_from_response(post(:activate))
+    end
+  end
+end

data/lib/duodealer_api/resources/application_credit.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class ApplicationCredit < Base
+  end
+end

data/lib/duodealer_api/resources/array_base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class ArrayBase < Base
+    class << self
+      private
+
+      def instantiate_record(record, *)
+        record
+      end
+    end
+  end
+end