my_api_client 0.14.0.pre → 0.17.0

data/lib/my_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '0.14.0.pre'
+  VERSION = '0.17.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.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.3)
+      actionpack (= 6.0.3.3)
+      actionview (= 6.0.3.3)
+      activejob (= 6.0.3.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.3)
+      actionview (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      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.3)
+      activesupport (= 6.0.3.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activerecord (6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activesupport (6.0.3.3)
+      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.7.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.2)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.5)
+    puma (5.0.0)
+      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.3)
+      actionpack (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      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

data/my_api/README.md

@@ -0,0 +1,54 @@
+# 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`
+
+### My Pagination API
+
+This API returns a response including pagination links.
+
+* `GET pagination?page=1`
+
+## 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
+```

data/my_api/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'jets'
+Jets.load_tasks

data/my_api/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# The root of the controller
+class ApplicationController < Jets::Controller::Base
+end

data/my_api/app/controllers/error_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# THe error code API
+class ErrorController < ApplicationController
+  # GET error/:code
+  def show
+    render status: :bad_request, json: error_response
+  end
+
+  private
+
+  def error_response
+    code = params[:code].to_i
+    {
+      error: {
+        code: code,
+        message: "You requested error code: #{code}",
+      },
+    }
+  end
+end

data/my_api/app/controllers/pagination_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# A Pagination API
+class PaginationController < ApplicationController
+  # GET pagination
+  def index
+    case params[:page]
+    when '1', nil
+      render status: :ok, json: first_page
+    when '2'
+      render status: :ok, json: second_page
+    when '3'
+      render status: :ok, json: third_page
+    else
+      render status: :not_found, json: ''
+    end
+  end
+
+  private
+
+  def first_page
+    {
+      links: {
+        next: page_link(2),
+      },
+      page: 1,
+    }
+  end
+
+  def second_page
+    {
+      links: {
+        next: page_link(3),
+        previous: page_link(1),
+      },
+      page: 2,
+    }
+  end
+
+  def third_page
+    {
+      links: {
+        previous: page_link(2),
+      },
+      page: 3,
+    }
+  end
+
+  # NOTE: `#pagination_url` returns `http://xxxxx.execute-api.ap-northeast-1.amazonaws.com/pagination`
+  #       but it should be `https://xxxxx.execute-api.ap-northeast-1.amazonaws.com/dev/pagination`.
+  #       So this is workaround.
+  def page_link(page)
+    query_strings = '?' + { page: page }.to_query
+    uri = File.join(ENV['JETS_HOST'], ENV['JETS_STAGE'], pagination_path)
+    uri.sub!('http://', 'https://')
+    URI.join(uri, query_strings)
+  end
+end