my_api_client 0.14.0.pre → 0.14.0

data/example/api_clients/my_errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MyErrors
+  # 400 Bad Request
+  class BadRequest < MyApiClient::ClientError; end
+
+  # 401 Unauthorized
+  class Unauthorized < MyApiClient::ClientError; end
+
+  # 403 Forbidden
+  class Forbidden < MyApiClient::ClientError; end
+
+  # Error code: 0
+  class ErrorCode00 < MyApiClient::ClientError; end
+
+  # Error code: 10
+  class ErrorCode10 < MyApiClient::ClientError; end
+
+  # Error code: 20 to 29
+  class ErrorCode2x < MyApiClient::ClientError; end
+
+  # Error code: 30
+  class ErrorCode30 < MyApiClient::ClientError; end
+
+  # Error code: other
+  class ErrorCodeOther < MyApiClient::ClientError; end
+end

data/example/api_clients/my_rest_api_client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'application_api_client'
+
+# An usage example of the `my_api_client`.
+# See also: my_api/app/controllers/rest_controller.rb
+class MyRestApiClient < ApplicationApiClient
+  # GET rest
+  def get_posts(order: :asc)
+    order = :desc unless order == :asc
+    query = { order: order }
+    get 'rest', query: query, headers: headers
+  end
+
+  # GET rest/:id
+  def get_post(id:)
+    get "rest/#{id}", headers: headers
+  end
+
+  # POST rest
+  def create_post(title:)
+    body = { title: title }
+    post 'rest', body: body, headers: headers
+  end
+
+  # POST/PUT/PATCH rest/:id
+  def update_post(id:, title:)
+    body = { title: title }
+    patch "rest/#{id}", body: body, headers: headers
+  end
+
+  # DELETE rest/:id
+  def delete_post(id:)
+    delete "rest/#{id}", headers: headers
+  end
+
+  private
+
+  def headers
+    { 'Content-Type': 'application/json;charset=UTF-8' }
+  end
+end

data/example/api_clients/my_status_api_client.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'application_api_client'
+
+# An usage example of the `my_api_client`.
+# See also: my_api/app/controllers/status_controller.rb
+class MyStatusApiClient < ApplicationApiClient
+  error_handling status_code: 400, raise: MyErrors::BadRequest
+  error_handling status_code: 401, raise: MyErrors::Unauthorized
+  error_handling status_code: 403, raise: MyErrors::Forbidden
+
+  # GET status/:status
+  def get_status(status:)
+    get "status/#{status}", headers: headers
+  end
+
+  private
+
+  def headers
+    { 'Content-Type': 'application/json;charset=UTF-8' }
+  end
+end

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.14.0.pre'
+  VERSION = '0.14.0'
 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.7.0

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.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      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.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.0.3)
+    aws-mfa-secure (0.4.0)
+      activesupport
+      aws-sdk-core
+      aws_config
+      memoist
+      rainbow
+      thor
+      zeitwerk
+    aws-partitions (1.278.0)
+    aws-sdk-apigateway (1.36.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-cloudformation (1.30.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-cloudwatchlogs (1.28.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.90.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-dynamodb (1.43.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-kinesis (1.20.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-kms (1.29.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-lambda (1.36.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.60.2)
+      aws-sdk-core (~> 3, >= 3.83.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sns (1.21.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sqs (1.23.1)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-ssm (1.71.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws_config (0.1.0)
+    builder (3.2.4)
+    byebug (11.1.1)
+    capybara (3.31.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.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    dynomite (1.2.5)
+      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.2)
+      concurrent-ruby (~> 1.0)
+    jets (2.3.13)
+      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
+      json
+      kramdown
+      memoist
+      mimemagic
+      rack
+      railties (~> 6.0.0)
+      rainbow
+      recursive-open-struct
+      shotgun
+      text-table
+      thor
+      zeitwerk
+    jets-gems (0.2.0)
+      gems
+    jets-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    jmespath (1.4.0)
+    json (2.3.0)
+    kramdown (2.1.0)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    memoist (0.16.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.3)
+    puma (4.3.3)
+      nio4r (~> 2.0)
+    rack (2.2.2)
+    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.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      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.0)
+    regexp_parser (1.7.0)
+    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.0)
+      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.6)
+      thread_safe (~> 0.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.2.2)
+
+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

data/my_api/README.md

@@ -0,0 +1,48 @@
+# My API
+
+This is the real API for integration testing with `my_api_client`.
+
+It's built by [Ruby on Jets](https://rubyonjets.com/).
+
+## APIs
+
+### My Rest API
+
+This is a simple REST API that returns a specified response.
+
+* `GET rest`
+* `GET rest/:id`
+* `POST rest`
+* `POST/PUT/PATCH rest/:id`
+* `DELETE rest/:id`
+
+### My Status API
+
+This API returns arbitrary status code.
+
+* `GET status/:status`
+
+### My Error API
+
+This API returns arbitrary error code as JSON.
+
+* `GET error/:code`
+
+## Deployment
+
+You need to prepare following environment variables:
+
+* `AWS_REGION`
+* `AWS_ACCESS_KEY_ID`
+* `AWS_SECRET_ACCESS_KEY`
+
+For information on how to create an AWS access key and secret, see the following site:
+
+:link: [Minimal Deploy IAM Policy \- Jets Ruby Serverless Framework](https://rubyonjets.com/docs/extras/minimal-deploy-iam/)
+
+
+And execute following command:
+
+```sh
+$ bundle exec jets deploy
+```