RubyGems - my_api_client - Versions diffs - 0.14.0.pre → 0.17.0 - Mend

my_api_client 0.14.0.pre → 0.17.0

Files changed (139) hide show

checksums.yaml +4 -4
data/.circleci/config.yml +179 -38
data/.dependabot/config.yml +19 -1
data/.envrc.skeleton +1 -0
data/.rubocop.yml +9 -1
data/.rubocop_challenge.yml +5 -0
data/.rubocop_todo.yml +29 -1
data/CHANGELOG.md +177 -1
data/Gemfile.lock +47 -45
data/README.jp.md +156 -21
data/bin/console +4 -0
data/example/api_clients/application_api_client.rb +13 -0
data/example/api_clients/my_error_api_client.rb +34 -0
data/example/api_clients/my_errors.rb +27 -0
data/example/api_clients/my_pagination_api_client.rb +18 -0
data/example/api_clients/my_rest_api_client.rb +48 -0
data/example/api_clients/my_status_api_client.rb +22 -0
data/lib/generators/rails/templates/application_api_client.rb.erb +0 -11
data/lib/generators/rspec/templates/api_client_spec.rb.erb +22 -15
data/lib/my_api_client.rb +7 -0
data/lib/my_api_client/base.rb +4 -2
data/lib/my_api_client/default_error_handlers.rb +64 -0
data/lib/my_api_client/error_handling.rb +6 -6
data/lib/my_api_client/error_handling/generator.rb +23 -7
data/lib/my_api_client/errors.rb +1 -53
data/lib/my_api_client/errors/api_limit_error.rb +6 -0
data/lib/my_api_client/errors/client_error.rb +93 -0
data/lib/my_api_client/errors/network_error.rb +43 -0
data/lib/my_api_client/errors/server_error.rb +42 -0
data/lib/my_api_client/request.rb +29 -34
data/lib/my_api_client/request/basic.rb +32 -0
data/lib/my_api_client/request/executor.rb +1 -1
data/lib/my_api_client/request/pagination.rb +39 -0
data/lib/my_api_client/rspec/matchers/request_to.rb +3 -4
data/lib/my_api_client/version.rb +1 -1
data/my_api/.envrc.skeleton +3 -0
data/my_api/.gitignore +14 -0
data/my_api/.jetskeep +1 -0
data/my_api/.rspec +3 -0
data/my_api/.ruby-version +1 -0
data/my_api/Gemfile +23 -0
data/my_api/Gemfile.lock +243 -0
data/my_api/Procfile +7 -0
data/my_api/README.md +54 -0
data/my_api/Rakefile +4 -0
data/my_api/app/controllers/application_controller.rb +5 -0
data/my_api/app/controllers/error_controller.rb +21 -0
data/my_api/app/controllers/pagination_controller.rb +58 -0
data/my_api/app/controllers/rest_controller.rb +60 -0
data/my_api/app/controllers/status_controller.rb +11 -0
data/my_api/app/helpers/application_helper.rb +5 -0
data/my_api/app/jobs/application_job.rb +7 -0
data/my_api/app/models/application_item.rb +5 -0
data/my_api/config.ru +7 -0
data/my_api/config/application.rb +73 -0
data/my_api/config/dynamodb.yml +22 -0
data/my_api/config/environments/development.rb +9 -0
data/my_api/config/environments/production.rb +11 -0
data/my_api/config/environments/test.rb +9 -0
data/my_api/config/routes.rb +17 -0
data/my_api/db/.gitkeep +0 -0
data/my_api/public/404.html +67 -0
data/my_api/public/422.html +67 -0
data/my_api/public/500.html +66 -0
data/my_api/public/favicon.ico +0 -0
data/my_api/public/index.html +91 -0
data/my_api/spec/controllers/error_controller_spec.rb +43 -0
data/my_api/spec/controllers/pagination_controller_spec.rb +73 -0
data/my_api/spec/controllers/rest_controller_spec.rb +99 -0
data/my_api/spec/controllers/status_controller_spec.rb +47 -0
data/my_api/spec/fixtures/payloads/posts-index.json +51 -0
data/my_api/spec/fixtures/payloads/posts-show.json +53 -0
data/my_api/spec/spec_helper.rb +31 -0
data/rails_app/rails_5.2/.rspec +3 -0
data/rails_app/rails_5.2/Gemfile +18 -0
data/rails_app/rails_5.2/Gemfile.lock +171 -0
data/rails_app/rails_5.2/README.md +24 -0
data/rails_app/rails_5.2/Rakefile +8 -0
data/rails_app/rails_5.2/app/controllers/application_controller.rb +4 -0
data/rails_app/rails_5.2/app/jobs/application_job.rb +4 -0
data/rails_app/rails_5.2/bin/bundle +5 -0
data/rails_app/rails_5.2/bin/rails +6 -0
data/rails_app/rails_5.2/bin/rake +6 -0
data/rails_app/rails_5.2/bin/setup +27 -0
data/rails_app/rails_5.2/bin/update +27 -0
data/rails_app/rails_5.2/config.ru +7 -0
data/rails_app/rails_5.2/config/application.rb +37 -0
data/rails_app/rails_5.2/config/boot.rb +6 -0
data/rails_app/rails_5.2/config/credentials.yml.enc +1 -0
data/rails_app/rails_5.2/config/environment.rb +7 -0
data/rails_app/rails_5.2/config/environments/development.rb +41 -0
data/rails_app/rails_5.2/config/environments/production.rb +70 -0
data/rails_app/rails_5.2/config/environments/test.rb +38 -0
data/rails_app/rails_5.2/config/initializers/application_controller_renderer.rb +9 -0
data/rails_app/rails_5.2/config/initializers/backtrace_silencers.rb +8 -0
data/rails_app/rails_5.2/config/initializers/cors.rb +17 -0
data/rails_app/rails_5.2/config/initializers/filter_parameter_logging.rb +6 -0
data/rails_app/rails_5.2/config/initializers/inflections.rb +17 -0
data/rails_app/rails_5.2/config/initializers/mime_types.rb +5 -0
data/rails_app/rails_5.2/config/initializers/wrap_parameters.rb +11 -0
data/rails_app/rails_5.2/config/locales/en.yml +33 -0
data/rails_app/rails_5.2/config/routes.rb +5 -0
data/rails_app/rails_5.2/config/spring.rb +8 -0
data/rails_app/rails_5.2/public/robots.txt +1 -0
data/rails_app/rails_5.2/spec/rails_helper.rb +14 -0
data/rails_app/rails_5.2/spec/spec_helper.rb +13 -0
data/rails_app/rails_6.0/.rspec +3 -0
data/rails_app/rails_6.0/Gemfile +17 -0
data/rails_app/rails_6.0/Gemfile.lock +186 -0
data/rails_app/rails_6.0/README.md +24 -0
data/rails_app/rails_6.0/Rakefile +8 -0
data/rails_app/rails_6.0/app/controllers/application_controller.rb +4 -0
data/rails_app/rails_6.0/app/jobs/application_job.rb +9 -0
data/rails_app/rails_6.0/bin/rails +6 -0
data/rails_app/rails_6.0/bin/rake +6 -0
data/rails_app/rails_6.0/bin/setup +27 -0
data/rails_app/rails_6.0/config.ru +7 -0
data/rails_app/rails_6.0/config/application.rb +39 -0
data/rails_app/rails_6.0/config/boot.rb +6 -0
data/rails_app/rails_6.0/config/credentials.yml.enc +1 -0
data/rails_app/rails_6.0/config/environment.rb +7 -0
data/rails_app/rails_6.0/config/environments/development.rb +39 -0
data/rails_app/rails_6.0/config/environments/production.rb +90 -0
data/rails_app/rails_6.0/config/environments/test.rb +41 -0
data/rails_app/rails_6.0/config/initializers/application_controller_renderer.rb +9 -0
data/rails_app/rails_6.0/config/initializers/backtrace_silencers.rb +8 -0
data/rails_app/rails_6.0/config/initializers/cors.rb +17 -0
data/rails_app/rails_6.0/config/initializers/filter_parameter_logging.rb +6 -0
data/rails_app/rails_6.0/config/initializers/inflections.rb +17 -0
data/rails_app/rails_6.0/config/initializers/mime_types.rb +5 -0
data/rails_app/rails_6.0/config/initializers/wrap_parameters.rb +11 -0
data/rails_app/rails_6.0/config/locales/en.yml +33 -0
data/rails_app/rails_6.0/config/routes.rb +5 -0
data/rails_app/rails_6.0/config/spring.rb +8 -0
data/rails_app/rails_6.0/public/robots.txt +1 -0
data/rails_app/rails_6.0/spec/rails_helper.rb +14 -0
data/rails_app/rails_6.0/spec/spec_helper.rb +13 -0
metadata +120 -5
data/renovate.json +0 -21

Binary file

@@ -0,0 +1,91 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Ruby on Jets</title>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width">
+  <style type="text/css" media="screen" charset="utf-8">
+    body {
+      text-align: center;
+      margin: 0;
+    }
+    img {
+      max-width: 320px;
+    }
+    .container {
+      max-width: 648px;
+    }
+    @media (min-width: 768px) {
+      img {
+        max-width: none;
+      }
+      .container {
+        max-width: none;
+      }
+    }
+    .header {
+      padding: 20px;
+      /*background-color: #b81513;*/
+      /*color: white;*/
+    }
+    .title {
+      font-size: 1.5em;
+    }
+    @media (max-width: 500px) {
+      .title {
+        font-size: 1.3em;
+      }
+    }
+    .intro {
+      text-align: left;
+      font-size: large;
+      margin: 0 auto;
+      padding: 0 20px;
+      max-width: 640px;
+    }
+    pre, code {
+      padding: 0;
+      margin: 0;
+    }
+    pre {
+      margin-left: 20px;
+      width: 99%;
+      overflow: auto;
+    }
+    @media (max-width: 500px) {
+      pre {
+        margin-left: -30px;
+        font-size: 0.8em;
+      }
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <header class="header">
+      <img src="https://s3.amazonaws.com/jets-public/jets/images/jets.png" class="logo" alt="logo" />
+      <h1 class="title">Welcome and congrats!<br /> Jets is running.</h1>
+    </header>
+    <div class="intro">
+      <p>
+        To get started:
+      </p>
+      <div class="code"><pre><code>
+        $ jets generate scaffold post title:string
+        $ jets db:create db:migrate
+        $ jets server
+        $ open http://localhost:8888/posts
+        $ jets help
+      </code></pre></div>
+      <p>More on info: <a href="http://rubyonjets.com">rubyonjets.com</a></p>
+      <p>Also check out the <a href="http://rubyonjets.com/reference">Jets CLI reference</a>.</p>
+    </div>
+    <p class="version">
+      <strong>Jets version:</strong> 2.3.13<br />
+      <strong>Ruby version:</strong> 2.5.3
+    </p>
+  </div>
+</body>
+</html>

data/my_api/spec/controllers/error_controller_spec.rb ADDED

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+describe ErrorController, type: :controller do
+  describe '#show' do
+    context 'when request error code 10' do
+      let(:code) { 10 }
+      let(:expected_response) do
+        {
+          error: {
+            code: code,
+            message: 'You requested error code: 10',
+          },
+        }.to_json
+      end
+      it 'returns 400 Bad request with error code 10' do
+        get '/error/:code', code: code
+        expect(response.status).to eq 400
+        expect(response.body).to eq expected_response
+      end
+    end
+    context 'when request error code 20' do
+      let(:code) { 20 }
+      let(:expected_response) do
+        {
+          error: {
+            code: code,
+            message: 'You requested error code: 20',
+          },
+        }.to_json
+      end
+      it 'returns 400 Bad request with error code 20' do
+        get '/error/:code', code: code
+        expect(response.status).to eq 400
+        expect(response.body).to eq expected_response
+      end
+    end
+  end
+end

data/my_api/spec/controllers/pagination_controller_spec.rb ADDED

@@ -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 ADDED

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+describe RestController, type: :controller do
+  describe '#index' do
+    context 'with order = asc' do
+      let(:array_of_posts) do
+        [
+          { id: 1, title: 'Title 1' },
+          { id: 2, title: 'Title 2' },
+          { id: 3, title: 'Title 3' },
+        ].to_json
+      end
+      it 'returns an array of posts ordered by id' do
+        get '/rest', order: 'asc'
+        expect(response.status).to eq 200
+        expect(response.body).to eq array_of_posts
+      end
+    end
+    context 'with order = desc' do
+      let(:array_of_posts) do
+        [
+          { id: 3, title: 'Title 3' },
+          { id: 2, title: 'Title 2' },
+          { id: 1, title: 'Title 1' },
+        ].to_json
+      end
+      it 'returns an array of posts reverse ordered by id' do
+        get '/rest', order: 'desc'
+        expect(response.status).to eq 200
+        expect(response.body).to eq array_of_posts
+      end
+    end
+  end
+  describe '#show' do
+    let(:post) do
+      { id: 1, title: 'Title 1' }.to_json
+    end
+    it 'returns a post' do
+      get '/rest/:id', id: 1
+      expect(response.status).to eq 200
+      expect(response.body).to eq post
+    end
+  end
+  describe '#create' do
+    let(:new_post) do
+      { id: 4, title: 'New title' }.to_json
+    end
+    it 'returns a created post' do
+      post '/rest', title: 'New title'
+      expect(response.status).to eq 201
+      expect(response.body).to eq new_post
+    end
+  end
+  describe '#update' do
+    let(:the_post) do
+      { id: 1, title: 'Modified title' }.to_json
+    end
+    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
+  describe '#delete' do
+    it 'returns no body' do
+      delete '/rest/:id', id: 123
+      expect(response.status).to eq 204
+      expect(response.body).to be_empty
+    end
+  end
+end

data/my_api/spec/controllers/status_controller_spec.rb ADDED

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+describe StatusController, type: :controller do
+  describe '#show' do
+    context 'when request status code 200' do
+      let(:status) { 200 }
+      let(:expected_response) do
+        { message: 'You requested status code: 200' }.to_json
+      end
+      it 'returns 200 OK' do
+        get '/status/:status', status: status
+        expect(response.status).to eq status
+        expect(response.body).to eq expected_response
+      end
+    end
+    context 'when request status code 400' do
+      let(:status) { 400 }
+      let(:expected_response) do
+        { message: 'You requested status code: 400' }.to_json
+      end
+      it 'returns 400 Bad request' do
+        get '/status/:status', status: status
+        expect(response.status).to eq status
+        expect(response.body).to eq expected_response
+      end
+    end
+    context 'when request status code 500' do
+      let(:status) { 500 }
+      let(:expected_response) do
+        { message: 'You requested status code: 500' }.to_json
+      end
+      it 'returns 500 Internal server error' do
+        get '/status/:status', status: status
+        expect(response.status).to eq status
+        expect(response.body).to eq expected_response
+      end
+    end
+  end
+end

data/my_api/spec/fixtures/payloads/posts-index.json ADDED

@@ -0,0 +1,51 @@
+{
+  "resource": "/posts",
+  "path": "/posts",
+  "httpMethod": "GET",
+  "headers": {
+    "Accept": "*/*",
+    "CloudFront-Forwarded-Proto": "https",
+    "CloudFront-Is-Desktop-Viewer": "true",
+    "CloudFront-Is-Mobile-Viewer": "false",
+    "CloudFront-Is-SmartTV-Viewer": "false",
+    "CloudFront-Is-Tablet-Viewer": "false",
+    "CloudFront-Viewer-Country": "US",
+    "Host": "qg45s7uvg2.execute-api.us-east-1.amazonaws.com",
+    "User-Agent": "curl/7.54.0",
+    "Via": "1.1 3d3d633d266d05d90a4eea7a6a59b514.cloudfront.net (CloudFront)",
+    "X-Amz-Cf-Id": "4mAgowukJJbA7lgTWITzgOPmdiDsXPCwy6vonS8VKPXCdEsmldVgdg==",
+    "X-Amzn-Trace-Id": "Root=1-59fb8ea5-38c5ad176dac130f3eb9ce97",
+    "X-Forwarded-For": "69.42.1.180, 54.239.203.118",
+    "X-Forwarded-Port": "443",
+    "X-Forwarded-Proto": "https"
+  },
+  "queryStringParameters": null,
+  "pathParameters": null,
+  "stageVariables": null,
+  "requestContext": {
+    "path": "/prod/posts",
+    "accountId": "123456789012",
+    "resourceId": "ery965",
+    "stage": "prod",
+    "requestId": "292fbcc8-c015-11e7-94fa-cd109b693f3c",
+    "identity": {
+      "cognitoIdentityPoolId": null,
+      "accountId": null,
+      "cognitoIdentityId": null,
+      "caller": null,
+      "apiKey": "",
+      "sourceIp": "69.42.1.180",
+      "accessKey": null,
+      "cognitoAuthenticationType": null,
+      "cognitoAuthenticationProvider": null,
+      "userArn": null,
+      "userAgent": "curl/7.54.0",
+      "user": null
+    },
+    "resourcePath": "/posts",
+    "httpMethod": "GET",
+    "apiId": "qg45s7uvg2"
+  },
+  "body": null,
+  "isBase64Encoded": false
+}

data/my_api/spec/fixtures/payloads/posts-show.json ADDED

@@ -0,0 +1,53 @@
+{
+  "resource": "/posts/{id}",
+  "path": "/posts/tung",
+  "httpMethod": "GET",
+  "headers": {
+    "Accept": "*/*",
+    "CloudFront-Forwarded-Proto": "https",
+    "CloudFront-Is-Desktop-Viewer": "true",
+    "CloudFront-Is-Mobile-Viewer": "false",
+    "CloudFront-Is-SmartTV-Viewer": "false",
+    "CloudFront-Is-Tablet-Viewer": "false",
+    "CloudFront-Viewer-Country": "US",
+    "Host": "qg45s7uvg2.execute-api.us-east-1.amazonaws.com",
+    "User-Agent": "curl/7.54.0",
+    "Via": "1.1 dc553909528b8b63475c922dc07d8ba6.cloudfront.net (CloudFront)",
+    "X-Amz-Cf-Id": "s9NB2f_Z1scd6ksA4fcXA2r4QhpSKQ6QcTLQHGfxDPfI-X7sXM3YLg==",
+    "X-Amzn-Trace-Id": "Root=1-59fb8ecb-586ab81d73e36910793d767c",
+    "X-Forwarded-For": "69.42.1.180, 54.239.203.97",
+    "X-Forwarded-Port": "443",
+    "X-Forwarded-Proto": "https"
+  },
+  "queryStringParameters": null,
+  "pathParameters": {
+    "id": "tung"
+  },
+  "stageVariables": null,
+  "requestContext": {
+    "path": "/prod/posts/tung",
+    "accountId": "123456789012",
+    "resourceId": "wf2gvu",
+    "stage": "prod",
+    "requestId": "3feafb4e-c015-11e7-85c9-194f38f4c414",
+    "identity": {
+      "cognitoIdentityPoolId": null,
+      "accountId": null,
+      "cognitoIdentityId": null,
+      "caller": null,
+      "apiKey": "",
+      "sourceIp": "69.42.1.180",
+      "accessKey": null,
+      "cognitoAuthenticationType": null,
+      "cognitoAuthenticationProvider": null,
+      "userArn": null,
+      "userAgent": "curl/7.54.0",
+      "user": null
+    },
+    "resourcePath": "/posts/{id}",
+    "httpMethod": "GET",
+    "apiId": "qg45s7uvg2"
+  },
+  "body": null,
+  "isBase64Encoded": false
+}