api_struct 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b4ddea2489ecf3ef083cd6b4ba06a1e5b1d2fdf
-  data.tar.gz: 5d55b25bec067bccf2fe8785badf9770937fc077
+  metadata.gz: 1846d9253d9d3bb8e7d8ed18ba445cebabf26b27
+  data.tar.gz: cdd2bc6c8104216e2938c2369120daeaaa1c0f0f
 SHA512:
-  metadata.gz: e596aef0eb1223dc8477f18822153b92505599d4cd8cc5657d32cdade2a80c0a10febfb1b73e0a33d37b103b653084723c0f633356d032b8a361bb613ee1fe58
-  data.tar.gz: 1ac9539e5216151b7cffae6b6973a369a0f095adea730613e9284059c91a2b129f55a42ff4cbad416d43927b51aebb2e9da890ead281be1893f51bd993787fc2
+  metadata.gz: 10c829780bff7016d56f7b3f53cd4b8b87e2a17193699c99653d5d7c5cedfb820603686992287198de61bebf05dd2a98e314046b4020a3b71c7301dcd8debb6e
+  data.tar.gz: de365513a4d9f53c31077379b95ae81f7cc47d464bb1043d844ee4cb2eec32670f9b43423130919c39cb481656b275db4fd74f4bf2cbae02ae0ee29a2c17691d

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    api_struct (1.0.0)
+    api_struct (1.0.1)
       dry-configurable (~> 0.7.0)
+      dry-inflector (~> 0.1.2)
       dry-monads (~> 1.0)
       hashie (~> 3.5, >= 3.5.6)
       http (>= 2.0.3)
@@ -15,7 +16,7 @@ GEM
     ast (2.3.0)
     byebug (9.1.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -23,17 +24,18 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
-    dry-core (0.4.7)
+    dry-core (0.4.8)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.1)
-    dry-monads (1.1.0)
+    dry-equalizer (0.2.2)
+    dry-inflector (0.1.2)
+    dry-monads (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer
     ffaker (2.8.0)
     hashdiff (0.3.7)
     hashie (3.6.0)
-    http (4.0.0)
+    http (4.1.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.0)
@@ -80,7 +82,7 @@ GEM
     safe_yaml (1.0.4)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
     unicode-display_width (1.3.0)
     vcr (3.0.3)
     webmock (3.2.1)
@@ -103,4 +105,4 @@ DEPENDENCIES
   webmock (~> 3.2, >= 3.2.1)
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/README.md

@@ -38,7 +38,7 @@ ApiStruct::Settings.configure do |config|
     },
     second_api: {
       root: 'http://localhost:3001/api/v1',
-      # etc...
+      params: { token: 'Default token' }
     }
   }
 end

data/api_struct.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dry-monads', '~> 1.0'
   spec.add_dependency 'dry-configurable', '~> 0.7.0'
+  spec.add_dependency 'dry-inflector', '~>  0.1.2'
   spec.add_dependency 'http', '>= 2.0.3'
   spec.add_dependency 'hashie', '~> 3.5', '>= 3.5.6'
 

data/lib/api_struct.rb

@@ -1,6 +1,7 @@
 require 'http'
 require 'dry/monads/result'
 require 'dry-configurable'
+require 'dry/inflector'
 require 'json'
 require 'hashie'
 

data/lib/api_struct/client.rb

@@ -13,6 +13,7 @@ module ApiStruct
       return super unless endpoints.keys.include?(method_name)
 
       define_method(:api_root) { endpoints[method_name][:root] }
+      define_method(:default_params) { endpoints[method_name][:params] || {} }
       define_method(:default_path) { first_arg(args) }
 
       define_method(:headers) do
@@ -25,6 +26,7 @@ module ApiStruct
     HTTP_METHODS.each do |http_method|
       define_method http_method do |*args, **options|
         begin
+          options[:params] = default_params.merge(options[:params] || {})
           wrap client.send(http_method, build_url(args, options), options)
         rescue HTTP::ConnectionError => e
           failure(body: e.message, status: :not_connected)

data/lib/api_struct/concerns/underscore.rb

@@ -1,11 +1,7 @@
 module Concerns
   module Underscore
     def underscore(camel_cased_word)
-      camel_cased_word.gsub(/::/, '/')
-        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-        .tr("-", "_")
-        .downcase
+      Dry::Inflector.new.underscore(camel_cased_word)
     end
   end
 end

data/lib/api_struct/entity.rb

@@ -76,7 +76,12 @@ module ApiStruct
     private
 
     def extract_attributes(attributes)
-      attributes.select { |key, _value| self.class.entity_attributes.include?(key.to_sym) }
+      formatted_attributes = attributes.map { |name, value| [format_name(name), value] }.to_h
+      formatted_attributes.select { |key, _value| self.class.entity_attributes.include?(key.to_sym) }
+    end
+
+    def format_name(name)
+      Dry::Inflector.new.underscore(name).to_sym
     end
   end
 

data/lib/api_struct/version.rb

@@ -1,3 +1,3 @@
 module ApiStruct
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/api_struct/client_spec.rb

@@ -1,7 +1,10 @@
 describe ApiStruct::Client do
   extend Support::Stub
-  let(:api_root) { 'https://jsonplaceholder.typicode.com' }
-  stub_api('https://jsonplaceholder.typicode.com')
+  API_ROOT = 'https://jsonplaceholder.typicode.com'
+
+  let(:api_root) { API_ROOT }
+  stub_api(API_ROOT)
+  let(:client) { StubClient.new }
 
   class StubClient < ApiStruct::Client
     stub_api :posts
@@ -17,7 +20,6 @@ describe ApiStruct::Client do
 
   context 'build url options' do
     context 'url options' do
-      let(:client) { StubClient.new }
       it ' should replace /posts/users/:id to /posts/users if URL option didnt provided' do
         url = client.send(:build_url, 'users/:id', {})
         expect(url).to eq api_root + '/posts/users'
@@ -57,9 +59,10 @@ describe ApiStruct::Client do
         expect(url).to eq api_root + '/users/1/posts/2'
       end
     end
+
     it 'should build url with prefix' do
       VCR.use_cassette('users/1/posts') do
-        response = StubClient.new.get(prefix: 'users/:id', id: 1)
+        response = client.get(prefix: 'users/:id', id: 1)
         expect(response).to be_success
         expect(response.value!).to be_kind_of Array
         expect(response.value!).not_to be_empty
@@ -68,7 +71,7 @@ describe ApiStruct::Client do
 
     it 'should build url with custom path' do
       VCR.use_cassette('todos') do
-        response = StubClient.new.get(path: 'todos/1')
+        response = client.get(path: 'todos/1')
         expect(response).to be_success
         expect(response.value![:id]).to eq(1)
         expect(response.value![:title]).not_to be_empty
@@ -76,9 +79,28 @@ describe ApiStruct::Client do
       end
     end
 
+    context 'Default params' do
+      let(:user_id) { 2 }
+
+      before do
+        allow(client).to receive(:default_params).and_return(userId: user_id)
+      end
+
+      it 'should build url with default params' do
+        VCR.use_cassette('user_todos') do
+          response = client.get(path: 'todos')
+
+          expect(response).to be_success
+          response.value!.each do |response|
+            expect(response[:userId]).to eq(user_id)
+          end
+        end
+      end
+    end
+
     it 'should build url with prefix as array' do
       VCR.use_cassette('todos') do
-        response = StubClient.new.get(path: [:todos, 1])
+        response = client.get(path: [:todos, 1])
         expect(response).to be_success
         expect(response.value![:id]).to eq(1)
         expect(response.value![:title]).not_to be_empty
@@ -90,7 +112,7 @@ describe ApiStruct::Client do
   context 'GET' do
     it 'when successful response' do
       VCR.use_cassette('posts/show_success') do
-        response = StubClient.new.show(1)
+        response = client.show(1)
         expect(response).to be_success
         expect(response.value![:id]).to eq(1)
         expect(response.value![:title]).not_to be_empty
@@ -99,7 +121,7 @@ describe ApiStruct::Client do
 
     it 'when failed response' do
       VCR.use_cassette('posts/show_failure') do
-        response = StubClient.new.show(101)
+        response = client.show(101)
         expect(response).to be_failure
         expect(response.failure.status).to eq(404)
       end
@@ -107,7 +129,7 @@ describe ApiStruct::Client do
 
     it 'when failed response with html response' do
       VCR.use_cassette('posts/show_failure_html') do
-        response = StubClient.new.show(101)
+        response = client.show(101)
         body     = response.failure.body
         expect(response).to be_failure
         expect(response.failure.status).to eq(404)
@@ -120,7 +142,7 @@ describe ApiStruct::Client do
   context 'PATCH' do
     it 'when successful response' do
       VCR.use_cassette('posts/update_success') do
-        response = StubClient.new.update(1, title: FFaker::Name.name)
+        response = client.update(1, title: FFaker::Name.name)
         expect(response).to be_success
         expect(response.value![:id]).to eq(1)
       end

data/spec/api_struct/entity_spec.rb

@@ -26,7 +26,7 @@ describe ApiStruct::Entity do
     client_service StubClient, prefix: :only, only: :index
     client_service StubClient, prefix: :except, except: :show
 
-    attr_entity :id, :title
+    attr_entity :id, :title, :camel_case
 
     has_entity :nested_entity, as: StubNestedEntity
     has_entities :another_nested_entities, as: StubNestedEntity
@@ -119,6 +119,7 @@ describe ApiStruct::Entity do
         expect(entity).to be_success
         expect(entity.id).to eq(1)
         expect(entity.title).not_to be_empty
+        expect(entity.camel_case).not_to be_empty
       end
     end
 

data/spec/fixtures/cassettes/posts/show_success.yml

@@ -66,6 +66,7 @@ http_interactions:
           "userId": 1,
           "id": 1,
           "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
+          "camelCase": "camel case property",
           "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
         }
     http_version: 

data/spec/fixtures/cassettes/user_todos.yml

@@ -0,0 +1,189 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://jsonplaceholder.typicode.com/todos?userId=2
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - jsonplaceholder.typicode.com
+      User-Agent:
+      - http.rb/4.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 17 Apr 2019 18:24:07 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Set-Cookie:
+      - __cfduid=dc82c08fc0528b00d44fd9dc69a3d5bf91555525447; expires=Thu, 16-Apr-20
+        18:24:07 GMT; path=/; domain=.typicode.com; HttpOnly
+      X-Powered-By:
+      - Express
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Cache-Control:
+      - public, max-age=14400
+      Pragma:
+      - no-cache
+      Expires:
+      - Wed, 17 Apr 2019 22:24:07 GMT
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - W/"940-PY6FbG4RbU9NVn6pD/xl3LdEHgs"
+      Via:
+      - 1.1 vegur
+      Cf-Cache-Status:
+      - HIT
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 4c906f20ea39cc81-WAW
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          {
+            "userId": 2,
+            "id": 21,
+            "title": "suscipit repellat esse quibusdam voluptatem incidunt",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 22,
+            "title": "distinctio vitae autem nihil ut molestias quo",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 23,
+            "title": "et itaque necessitatibus maxime molestiae qui quas velit",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 24,
+            "title": "adipisci non ad dicta qui amet quaerat doloribus ea",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 25,
+            "title": "voluptas quo tenetur perspiciatis explicabo natus",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 26,
+            "title": "aliquam aut quasi",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 27,
+            "title": "veritatis pariatur delectus",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 28,
+            "title": "nesciunt totam sit blanditiis sit",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 29,
+            "title": "laborum aut in quam",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 30,
+            "title": "nemo perspiciatis repellat ut dolor libero commodi blanditiis omnis",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 31,
+            "title": "repudiandae totam in est sint facere fuga",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 32,
+            "title": "earum doloribus ea doloremque quis",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 33,
+            "title": "sint sit aut vero",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 34,
+            "title": "porro aut necessitatibus eaque distinctio",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 35,
+            "title": "repellendus veritatis molestias dicta incidunt",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 36,
+            "title": "excepturi deleniti adipisci voluptatem et neque optio illum ad",
+            "completed": true
+          },
+          {
+            "userId": 2,
+            "id": 37,
+            "title": "sunt cum tempora",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 38,
+            "title": "totam quia non",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 39,
+            "title": "doloremque quibusdam asperiores libero corrupti illum qui omnis",
+            "completed": false
+          },
+          {
+            "userId": 2,
+            "id": 40,
+            "title": "totam atque quo nesciunt",
+            "completed": true
+          }
+        ]
+    http_version: 
+  recorded_at: Wed, 17 Apr 2019 18:24:07 GMT
+recorded_with: VCR 3.0.3

data/spec/support/stub.rb

@@ -1,8 +1,8 @@
 module Support
   module Stub
-    def stub_api(root)
+    def stub_api(root, params = {})
       ApiStruct::Settings.configure do |config|
-        config.endpoints = { stub_api: { root: root } }
+        config.endpoints = { stub_api: { root: root, params: params } }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_struct
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - bezrukavyi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -40,6 +40,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -243,6 +257,7 @@ files:
 - spec/fixtures/cassettes/posts/suffix.yml
 - spec/fixtures/cassettes/posts/update_success.yml
 - spec/fixtures/cassettes/todos.yml
+- spec/fixtures/cassettes/user_todos.yml
 - spec/fixtures/cassettes/users/1/posts.yml
 - spec/fixtures/cassettes/users/1/posts/1.yml
 - spec/spec_helper.rb