my_api_client 0.14.0 → 0.18.0

data/my_api/README.md

@@ -28,6 +28,12 @@ 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:

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/config/routes.rb

@@ -7,6 +7,7 @@ Jets.application.routes.draw do
 
   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

data/my_api/spec/controllers/pagination_controller_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+describe PaginationController, type: :controller do
+  describe '#index' do
+    let(:first_page) do
+      {
+        links: {
+          next: 'https://example.com/test/pagination?page=2',
+        },
+        page: 1,
+      }.to_json
+    end
+
+    let(:second_page) do
+      {
+        links: {
+          next: 'https://example.com/test/pagination?page=3',
+          previous: 'https://example.com/test/pagination?page=1',
+        },
+        page: 2,
+      }.to_json
+    end
+
+    let(:third_page) do
+      {
+        links: {
+          previous: 'https://example.com/test/pagination?page=2',
+        },
+        page: 3,
+      }.to_json
+    end
+
+    context 'without page' do
+      it 'returns a 1st page contents including 2nd page link' do
+        get '/pagination'
+        expect(response.status).to eq 200
+        expect(response.body).to eq first_page
+      end
+    end
+
+    context 'with page = 1' do
+      it 'returns a 1st page contents including 2nd page link' do
+        get '/pagination', page: 1
+        expect(response.status).to eq 200
+        expect(response.body).to eq first_page
+      end
+    end
+
+    context 'with page = 2' do
+      it 'returns a 2nd page contents including 3rd page link' do
+        get '/pagination', page: 2
+        expect(response.status).to eq 200
+        expect(response.body).to eq second_page
+      end
+    end
+
+    context 'with page = 3' do
+      it 'returns a 3rd page contents not including next page link' do
+        get '/pagination', page: 3
+        expect(response.status).to eq 200
+        expect(response.body).to eq third_page
+      end
+    end
+
+    context 'with page = 4' do
+      it 'returns 404 NOT FOUND' do
+        get '/pagination', page: 4
+        expect(response.status).to eq 404
+        expect(response.body).to be_blank
+      end
+    end
+  end
+end

data/my_api/spec/controllers/rest_controller_spec.rb

@@ -60,14 +60,32 @@ describe RestController, type: :controller do
   end
 
   describe '#update' do
-    let(:post) do
+    let(:the_post) do
       { id: 1, title: 'Modified title' }.to_json
     end
 
-    it 'returns a updated post' do
-      patch '/rest/:id', id: 1, title: 'Modified title'
-      expect(response.status).to eq 200
-      expect(response.body).to eq post
+    context 'with POST method' do
+      it 'returns a updated post' do
+        post '/rest/:id', id: 1, title: 'Modified title'
+        expect(response.status).to eq 200
+        expect(response.body).to eq the_post
+      end
+    end
+
+    context 'with PUT method' do
+      it 'returns a updated post' do
+        put '/rest/:id', id: 1, title: 'Modified title'
+        expect(response.status).to eq 200
+        expect(response.body).to eq the_post
+      end
+    end
+
+    context 'with PATCH method' do
+      it 'returns a updated post' do
+        patch '/rest/:id', id: 1, title: 'Modified title'
+        expect(response.status).to eq 200
+        expect(response.body).to eq the_post
+      end
     end
   end
 

data/my_api/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 ENV['JETS_TEST'] = '1'
 ENV['JETS_ENV'] ||= 'test'
+ENV['JETS_STAGE'] ||= 'test'
 # Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
 ENV['HOME'] = 'spec/fixtures/home'
 
@@ -24,3 +25,7 @@ end
 RSpec.configure do |c|
   c.include Helpers
 end
+
+Jets.application.configure do
+  config.helpers.host = 'https://example.com'
+end

data/my_api_client.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_dependency 'activesupport', '>= 4.2.0'
+  spec.add_dependency 'activesupport', '>= 5.0.0'
   spec.add_dependency 'faraday', '>= 0.17.1'
   spec.add_dependency 'jsonpath'
   spec.add_dependency 'sawyer', '>= 0.8.2'

data/rails_app/rails_5.2/.rspec

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

data/rails_app/rails_5.2/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem 'bootsnap', '>= 1.1.0', require: false
+gem 'my_api_client', path: '../..'
+gem 'rails', '~> 5.2.4'
+
+group :development, :test do
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
+  gem 'rspec-rails'
+end
+
+group :development do
+  gem 'spring'
+end

data/rails_app/rails_5.2/Gemfile.lock

@@ -0,0 +1,171 @@
+PATH
+  remote: ../..
+  specs:
+    my_api_client (0.17.0)
+      activesupport (>= 5.0.0)
+      faraday (>= 0.17.1)
+      jsonpath
+      sawyer (>= 0.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      actionview (= 5.2.4.4)
+      activejob (= 5.2.4.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4.4)
+      actionview (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.4)
+      activesupport (= 5.2.4.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.4.4)
+      activesupport (= 5.2.4.4)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4.4)
+      activesupport (= 5.2.4.4)
+    activerecord (5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      arel (>= 9.0)
+    activestorage (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activerecord (= 5.2.4.4)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    arel (9.0.0)
+    bootsnap (1.4.8)
+      msgpack (~> 1.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jsonpath (1.0.5)
+      multi_json
+      to_regexp (~> 0.2.1)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    msgpack (1.3.3)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.4)
+      actioncable (= 5.2.4.4)
+      actionmailer (= 5.2.4.4)
+      actionpack (= 5.2.4.4)
+      actionview (= 5.2.4.4)
+      activejob (= 5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activerecord (= 5.2.4.4)
+      activestorage (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      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-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    spring (2.1.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    to_regexp (0.2.1)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bootsnap (>= 1.1.0)
+  byebug
+  my_api_client!
+  rails (~> 5.2.4)
+  rspec-rails
+  spring
+  sprockets (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/rails_app/rails_5.2/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/rails_app/rails_5.2/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks