my_api_client 0.13.0 → 0.16.1

data/lib/my_api_client/request/logger.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module Request
+    # Description of Logger
+    class Logger
+      attr_reader :logger, :method, :uri
+
+      LOG_LEVEL = %i[debug info warn error fatal].freeze
+
+      # Description of #initialize
+      #
+      # @param logger [::Logger] describe_logger_here
+      # @param method [String] HTTP method
+      # @param uri [URI] Target URI
+      def initialize(logger, method, uri)
+        @logger = logger
+        @method = method.to_s.upcase
+        @uri = uri
+      end
+
+      LOG_LEVEL.each do |level|
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{level}(message)
+            logger.#{level}(format(message))
+          end
+        METHOD
+      end
+
+      private
+
+      def format(message)
+        "API request `#{method} #{uri}`: \"#{message}\""
+      end
+    end
+  end
+end

data/lib/my_api_client/request/pagination.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module Request
+    # Provides enumerable HTTP request method.
+    module Pagination
+      # Executes HTTP request with GET method, for pagination API. Expects the
+      # pagination API to provide pagination links as part of the content of the response.
+      #
+      # @param pathname [String]
+      #   Pathname of the request target URL. It's joined with the defined by `endpoint`.
+      # @param paging [String]
+      #   Specify the pagination link path included in the response body as JsonPath expression
+      # @param headers [Hash, nil]
+      #   Request headers.
+      # @param query [Hash, nil]
+      #   Query string.
+      # @param body [Hash, nil]
+      #   Request body. You should not specify it when use GET method.
+      # @return [Enumerator::Lazy]
+      #   Yields the pagination API response.
+      def pageable_get(pathname, paging:, headers: nil, query: nil)
+        Enumerator.new do |y|
+          response = call(:_request_with_relative_uri, :get, pathname, headers, query, nil)
+          loop do
+            y << response.data
+
+            next_uri = JsonPath.new(paging).first(response.body)
+            break if next_uri.blank?
+
+            response = call(:_request_with_absolute_uri, :get, next_uri, headers, nil)
+          end
+        end.lazy
+      end
+
+      alias pget pageable_get
+    end
+  end
+end

data/lib/my_api_client/rspec/matcher_helper.rb

@@ -4,8 +4,8 @@ module MyApiClient
   # Helper module for rspec custom matcher
   module MatcherHelper
     def disable_logging
-      logger = instance_double(MyApiClient::Logger, info: nil, warn: nil)
-      allow(MyApiClient::Logger).to receive(:new).and_return(logger)
+      logger = instance_double(MyApiClient::Request::Logger, info: nil, warn: nil)
+      allow(MyApiClient::Request::Logger).to receive(:new).and_return(logger)
     end
 
     def dummy_response(status: 200, headers: {}, body: nil)

data/lib/my_api_client/rspec/matchers/be_handled_as_an_error.rb

@@ -45,6 +45,7 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
 
   attr_reader :sawyer
 
+  # rubocop:disable Metrics/AbcSize
   def init
     disable_logging
     response = dummy_response(
@@ -56,6 +57,7 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
     allow(Sawyer::Agent).to receive(:new).and_return(sawyer)
     allow(MyApiClient::Sleeper).to receive(:call)
   end
+  # rubocop:enable Metrics/AbcSize
 
   def set_validation_for_retry_count
     return if retry_count.nil?

data/lib/my_api_client/rspec/matchers/request_to.rb

@@ -8,10 +8,9 @@ RSpec::Matchers.define :request_to do |expected_method, expected_url|
   match do |api_request|
     disable_logging
     @expected = {
-      request_line: request_line(expected_method, expected_url),
+      request_line: request_line(expected_method, expected_url, expected_options[:query]),
       body: expected_options[:body],
       headers: expected_options[:headers],
-      query: expected_options[:query],
     }.compact
     @actual = {}
     sawyer = instance_double(Sawyer::Agent)
@@ -24,7 +23,6 @@ RSpec::Matchers.define :request_to do |expected_method, expected_url|
           request_line: request_line(method, @actual_schema_and_hostname + pathname),
           body: body,
           headers: options[:headers],
-          query: options[:query],
         }.compact
     end.and_return(dummy_response)
     safe_execution(api_request)
@@ -51,7 +49,8 @@ RSpec::Matchers.define :request_to do |expected_method, expected_url|
     nil
   end
 
-  def request_line(method, url)
+  def request_line(method, url, query = nil)
+    url += '?' + query.to_query if query.present?
     "#{method.upcase} #{url}"
   end
 

data/lib/my_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '0.13.0'
+  VERSION = '0.16.1'
 end

data/my_api/.envrc.skeleton

@@ -0,0 +1,3 @@
+export AWS_REGION=ap-northeast-1
+export AWS_ACCESS_KEY_ID={AWS Access Key ID}
+export AWS_SECRET_ACCESS_KEY={AWS Secret Access Key}

data/my_api/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.bundle
+.byebug_history
+.DS_Store
+.env
+.env.*
+.envrc
+/node_modules
+/public/packs
+/public/packs-test
+bundled
+coverage
+pkg
+tmp

data/my_api/.jetskeep

@@ -0,0 +1 @@
+pack

data/my_api/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/my_api/.ruby-version

@@ -0,0 +1 @@
+2.5.7

data/my_api/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jets'
+
+gem 'dynomite'
+
+# development and test groups are not bundled as part of the deployment
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
+  gem 'puma'
+  gem 'rack'
+  gem 'shotgun'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'launchy'
+  gem 'rspec'
+  gem 'rspec_junit_formatter'
+end

data/my_api/Gemfile.lock

@@ -0,0 +1,243 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.1.0)
+    aws-mfa-secure (0.4.2)
+      activesupport
+      aws-sdk-core
+      aws_config
+      memoist
+      rainbow
+      thor
+      zeitwerk
+    aws-partitions (1.358.0)
+    aws-sdk-apigateway (1.49.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-cloudformation (1.41.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-cloudwatchlogs (1.34.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.104.4)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-dynamodb (1.51.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-kinesis (1.27.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-kms (1.36.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-lambda (1.48.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.78.0)
+      aws-sdk-core (~> 3, >= 3.104.3)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sns (1.29.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sqs (1.30.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-ssm (1.86.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    aws_config (0.1.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    capybara (3.33.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    cfn_camelizer (0.4.9)
+      activesupport
+      memoist
+      rainbow
+    cfnresponse (0.4.0)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    dotenv (2.7.6)
+    dynomite (1.2.6)
+      activesupport
+      aws-sdk-dynamodb
+      rainbow
+    erubi (1.9.0)
+    gems (1.2.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    hashie (4.1.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jets (2.3.17)
+      actionmailer (~> 6.0.0)
+      actionpack (~> 6.0.0)
+      actionview (~> 6.0.0)
+      activerecord (~> 6.0.0)
+      activesupport (~> 6.0.0)
+      aws-mfa-secure (~> 0.4.0)
+      aws-sdk-apigateway
+      aws-sdk-cloudformation
+      aws-sdk-cloudwatchlogs
+      aws-sdk-dynamodb
+      aws-sdk-kinesis
+      aws-sdk-lambda
+      aws-sdk-s3
+      aws-sdk-sns
+      aws-sdk-sqs
+      aws-sdk-ssm
+      cfn_camelizer (~> 0.4.6)
+      cfnresponse
+      dotenv
+      gems
+      hashie
+      jets-gems
+      jets-html-sanitizer
+      kramdown
+      memoist
+      mimemagic
+      rack
+      railties (~> 6.0.0)
+      rainbow
+      recursive-open-struct
+      shotgun
+      text-table
+      thor
+      zeitwerk
+    jets-gems (0.2.2)
+      gems
+    jets-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    jmespath (1.4.0)
+    kramdown (2.3.0)
+      rexml
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.5)
+    puma (4.3.5)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    recursive-open-struct (1.1.2)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    shotgun (0.9.2)
+      rack (>= 1.0)
+    text-table (1.2.4)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  capybara
+  dynomite
+  jets
+  launchy
+  puma
+  rack
+  rspec
+  rspec_junit_formatter
+  shotgun
+
+BUNDLED WITH
+   2.1.4

data/my_api/Procfile

@@ -0,0 +1,7 @@
+local: dynamodb-local # port 8000
+admin: env AWS_ACCESS_KEY_ID=$DYNAMODB_ADMIN_AWS_ACCESS_KEY_ID PORT=8001 dynamodb-admin # port 8001
+# web: jets server # port 8888
+
+# Using Procfile to just start local dynamodb services for now.
+# To start jets server for now use:
+#   jets server