my_api_client 0.13.0 → 0.16.1

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

data/my_api/app/controllers/rest_controller.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# A REST API
+class RestController < ApplicationController
+  # GET rest
+  def index
+    result = params[:order] == 'desc' ? posts.reverse : posts
+    render status: :ok, json: result
+  end
+
+  # GET rest/:id
+  def show
+    render status: :ok, json: find_post(id: id)
+  end
+
+  # POST rest
+  def create
+    render status: :created,
+           json: create_post(title: params[:title])
+  end
+
+  # POST/PUT/PATCH rest/:id
+  def update
+    render status: :ok,
+           json: update_post(id: id, title: params[:title])
+  end
+
+  # DELETE rest/:id
+  def delete
+    render status: :no_content
+  end
+
+  private
+
+  def id
+    params[:id].to_i
+  end
+
+  def posts
+    [
+      { id: 1, title: 'Title 1' },
+      { id: 2, title: 'Title 2' },
+      { id: 3, title: 'Title 3' },
+    ]
+  end
+
+  def find_post(id:)
+    posts.find { |p| p[:id] == id }
+  end
+
+  def create_post(title:)
+    { id: 4, title: title }
+  end
+
+  def update_post(id:, title:)
+    find_post(id: id).tap do |post|
+      post[:title] = title
+    end
+  end
+end

data/my_api/app/controllers/status_controller.rb

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

data/my_api/app/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# The root of the helper module
+module ApplicationHelper
+end

data/my_api/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# The root of the job class
+class ApplicationJob < Jets::Job::Base
+  # Adjust to increase the default timeout for all Job classes
+  class_timeout 60
+end

data/my_api/app/models/application_item.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# The root of the model
+class ApplicationItem < Dynomite::Item
+end

data/my_api/config.ru

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+
+require 'jets'
+Jets.boot
+run Jets.application

data/my_api/config/application.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+Jets.application.configure do
+  config.project_name = 'my_api'
+  config.mode = 'api'
+
+  config.prewarm.enable = true # default is true
+  # config.prewarm.rate = '30 minutes' # default is '30 minutes'
+  # config.prewarm.concurrency = 2 # default is 2
+  # config.prewarm.public_ratio = 3 # default is 3
+
+  # config.env_extra = 2 # can also set this with JETS_ENV_EXTRA
+  # config.autoload_paths = []
+
+  # config.asset_base_url = 'https://cloudfront.domain.com/assets' # example
+
+  # config.cors = true # for '*'' # defaults to false
+  # config.cors = '*.mydomain.com' # for specific domain
+
+  # config.function.timeout = 30 # defaults to 30
+  # config.function.role = "arn:aws:iam::#{Jets.aws.account}:role/service-role/pre-created"
+  # config.function.memory_size = 1536
+
+  # Default is 'EDGE'
+  # https://docs.aws.amazon.com/apigateway/api-reference/link-relation/restapi-create/#endpointConfiguration
+  # config.api.endpoint_type = 'PRIVATE'
+
+  # config.function.environment = {
+  #   global_app_key1: "global_app_value1",
+  #   global_app_key2: "global_app_value2",
+  # }
+  # More examples:
+  # config.function.dead_letter_config = { target_arn: "arn" }
+  # config.function.vpc_config = {
+  #   security_group_ids: %w[sg-1 sg-2],
+  #   subnet_ids: %w[subnet-1 subnet-2],
+  # }
+  # The config.function settings to the CloudFormation Lambda Function properties.
+  # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html
+  # Underscored format can be used for keys to make it look more ruby-ish.
+
+  # Assets settings
+  # The config.assets.folders are folders within the public folder that will be set
+  # to public-read on s3 and served directly. IE: public/assets public/images public/packs
+  # config.assets.folders = %w[assets images packs]
+  # config.assets.max_age = 3600 # when to expire assets
+  #
+  # # IE: "public, max-age=3600" # override max_age for more fine-grain control.
+  # config.assets.cache_control = nil
+  #
+  # IE: https://cloudfront.com/my/base/path, defaults to the s3 bucket url
+  # IE: https://s3-us-west-2.amazonaws.com/demo-dev-s3bucket-1inlzkvujq8zb
+  # config.assets.base_url = nil
+  #
+
+  # config.api.endpoint_type = 'PRIVATE' # Default is 'EDGE' https://amzn.to/2r0Iu2L
+  # config.api.authorization_type = "AWS_IAM" # default is 'NONE' https://amzn.to/2qZ7zLh
+
+  # More info: http://rubyonjets.com/docs/routing/custom-domain/
+  # config.domain.hosted_zone_name = "example.com"
+  # us-west-2 REGIONAL endpoint - takes 2 minutes
+  # config.domain.cert_arn = "arn:aws:acm:us-west-2:112233445566:certificate/8d8919ce-a710-4050-976b-b33da991e123"
+  # us-east-1 EDGE endpoint - takes 10-15 minutes
+  # config.domain.cert_arn = "arn:aws:acm:us-east-1:112233445566:certificate/d68472ba-04f8-45ba-b9db-14f839d57123"
+  # config.domain.endpoint_type = "EDGE"
+
+  # By default logger needs to log to $stderr for CloudWatch to receive Lambda messages, but for
+  # local testing environment you may want to log these messages to 'test.log' file to keep your
+  # testing suite output readable.
+  # config.logger = Jets::Logger.new($strerr)
+
+  config.controllers.default_protect_from_forgery = false
+end

data/my_api/config/dynamodb.yml

@@ -0,0 +1,22 @@
+# Jets::Config.project_namespace is special value results in using the project namespace. Example :
+# table_namespace: <%= Jets.config.project_namespace %>
+# This is the default value.
+
+development:
+  table_namespace: <%= Jets.config.table_namespace %>
+  # More examples:
+  # table_namespace: demo-dev
+
+  endpoint: http://localhost:8000 # comment out if want to test with real dynamodb
+  # on AWS. You can also set the DYNAMODB_ENDPOINT environment variable.
+  # You can also are actually deploying a development environment is to
+  # change bin/server and export DYNAMODB_ENDPOINT=http://localhost:8000 at the top
+  # there.
+
+test:
+  # table_namespace: proj # do not include the env
+  endpoint: http://localhost:8000
+  table_namespace: <%= Jets.config.table_namespace %>
+
+production:
+  table_namespace: <%= Jets.config.table_namespace %>

data/my_api/config/environments/development.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Jets.application.configure do
+  # Example:
+  # config.function.memory_size = 1536
+
+  # config.action_mailer.raise_delivery_errors = false
+  # Docs: http://rubyonjets.com/docs/email-sending/
+end

data/my_api/config/environments/production.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Jets.application.configure do
+  # Example:
+  # config.function.memory_size = 2048
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # Docs: http://rubyonjets.com/docs/email-sending/
+  # config.action_mailer.raise_delivery_errors = false
+end

data/my_api/config/environments/test.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Jets.application.configure do
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # Docs: http://rubyonjets.com/docs/email-sending/
+  config.action_mailer.delivery_method = :test
+end

data/my_api/config/routes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Jets.application.routes.draw do
+  root 'jets/public#show'
+
+  resources 'rest', only: %i[index show create update delete]
+
+  get 'status/:status', to: 'status#show'
+  get 'error/:code', to: 'error#show'
+  get 'pagination', to: 'pagination#index'
+
+  # The jets/public#show controller can serve static utf8 content out of the public folder.
+  # Note, as part of the deploy process Jets uploads files in the public folder to s3
+  # and serves them out of s3 directly. S3 is well suited to serve static assets.
+  # More info here: https://rubyonjets.com/docs/extras/assets-serving/
+  any '*catchall', to: 'jets/public#show'
+end

data/my_api/public/404.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>