api_struct 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d1040aa384318bbffeb1b90f19db3f980aa4469
-  data.tar.gz: 0d77437b31acf598ead5c8bc7a756c55ea4b837a
+  metadata.gz: e44363911471e7d9ba624a1a2ed6206c11f7b340
+  data.tar.gz: f6ba8b892e2541d50355a0f5f6f9c544f43e29d8
 SHA512:
-  metadata.gz: 3d9aeaace35a53c521bd81cde6addf3f3c2f1439887165523ba026db7f92434e07c4b8526c99d89dfad738b14fc2f184064e52f2588f8a951a676882c94a5f48
-  data.tar.gz: c00a0bdcacbda8c59b95795a67304a8b9697ce6bd31dfaba9628f6aec32f8a979e7a981d926f8e5333ae5438745e9f00f2ec28ffb79b8879cfeb1a3eb4b09449
+  metadata.gz: de40c7dbef03649602cdb0e7e7f8cb16c289a6f14275b332cb5e4d820c6fa8f08a11b32f6f44ffabbe47f94a6f7fc72129236fa238cee6007425583d34de00c3
+  data.tar.gz: 34e71ed56918320e1340c97ec7cfa879ba7e0a92dc357867e620a8ad4344dffdf0e2b85bbea4b575acb7484f13bbb0174109c9320deb05486b576c8c3a649c3b

data/.circleci/config.yml

@@ -0,0 +1,25 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4-node 
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - api-struct-bundle-v2-{{ checksum "api_struct.gemspec" }}
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: api-struct-bundle-v2-{{ checksum "api_struct.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run Rspec
+          command: bundle exec rspec 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    api_struct (0.1.0)
+    api_struct (1.0.0)
       dry-configurable (~> 0.7.0)
-      dry-monads (~> 0.3.1)
+      dry-monads (~> 1.0)
       hashie (~> 3.5, >= 3.5.6)
       http (>= 2.0.3)
 
@@ -15,31 +15,32 @@ GEM
     ast (2.3.0)
     byebug (9.1.0)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    domain_name (0.5.20170404)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
-    dry-core (0.4.1)
+    dry-core (0.4.7)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.0)
-    dry-monads (0.3.1)
-      dry-core
+    dry-equalizer (0.2.1)
+    dry-monads (1.1.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer
     ffaker (2.8.0)
     hashdiff (0.3.7)
-    hashie (3.5.6)
-    http (3.0.0)
+    hashie (3.6.0)
+    http (4.0.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (>= 2.0.0.pre.pre2, < 3)
+      http-form_data (~> 2.0)
       http_parser.rb (~> 0.6.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.0.0)
+    http-form_data (2.1.1)
     http_parser.rb (0.6.0)
     method_source (0.9.0)
     parallel (1.12.0)
@@ -79,7 +80,7 @@ GEM
     safe_yaml (1.0.4)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.4)
+    unf_ext (0.0.7.5)
     unicode-display_width (1.3.0)
     vcr (3.0.3)
     webmock (3.2.1)
@@ -102,4 +103,4 @@ DEPENDENCIES
   webmock (~> 3.2, >= 3.2.1)
 
 BUNDLED WITH
-   1.16.0
+   1.17.1

data/README.md

@@ -2,6 +2,10 @@
 
 **ApiStruct** consists of two main interfaces: `ApiStruct::Client` and `ApiStruct::Entity`. The `ApiStruct::Client` class is aimed at using the same interface for describing requests to different APIs. The `ApiStruct::Entity` enables you to use *ApiStruct* clients in ORM-like style.
 
+[![Gem Version](https://badge.fury.io/rb/api_struct.svg)](https://badge.fury.io/rb/api_struct)
+![Maintainability](https://api.codeclimate.com/v1/badges/dc07c83ccbcaaebc6c44/maintainability)
+[![CircleCI](https://circleci.com/gh/rubygarage/api_struct/tree/master.svg?style=svg)](https://circleci.com/gh/rubygarage/api_struct/tree/master)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -54,13 +58,13 @@ class PostsClient < ApiStruct::Client
   def index
     get
   end
-  
+
   def user_posts(user_id, post_id = nil)
-    get(post_id, prefix: [:users, user_id]) 
-    # alias: 
+    get(post_id, prefix: [:users, user_id])
+    # alias:
     # get(post_id, prefix: '/users/:id', id: user_id)
   end
-  
+
   def custom_path(user_id)
     get(path: 'users_posts/:user_id', user_id: user_id)
   end
@@ -71,16 +75,16 @@ Usage:
 ```ruby
 PostsClient.new.get(1) # -> /posts/1
 ```
-Returns `Either` [monad](https://github.com/dry-rb/dry-monads)
+Returns `Result` [monad](https://dry-rb.org/gems/dry-monads/1.0/result/)
 ```ruby
-# => Right({:id=>1, :title=>"Post"})
+# => Success({:id=>1, :title=>"Post"})
 ```
 
 Other methods from sample:
 ```ruby
 post_client = PostsClient.new
 
-post_client.index            # -> /posts 
+post_client.index            # -> /posts
 post_client.user_posts(1)    # -> /users/1/posts
 post_client.user_posts(1, 2) # -> /users/1/posts/2
 post_client.custom_path(1)   # -> /users_posts/1/
@@ -95,9 +99,9 @@ class User < ApiStruct::Entity
   client_service UsersClient
 
   client_service AuthorsClient, prefix: true, only: :index
-  # alias: 
+  # alias:
   # client_service AuthorsClient, prefix: :prefix, except: :index
-  
+
   attr_entity :name, :id
 end
 ```
@@ -201,3 +205,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/rubyga
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+***
+<a href="https://rubygarage.org/"><img src="https://rubygarage.s3.amazonaws.com/assets/assets/rg_color_logo_horizontal-919afc51a81d2e40cb6a0b43ee832e3fcd49669d06785156d2d16fd0d799f89e.png" alt="RubyGarage Logo" width="415" height="128"></a>
+
+RubyGarage is a leading software development and consulting company in Eastern Europe. Our main expertise includes Ruby and Ruby on Rails, but we successfully employ other technologies to deliver the best results to our clients. [Check out our portfolio](https://rubygarage.org/portfolio) for even more exciting works!

data/api_struct.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-monads', '~> 0.3.1'
+  spec.add_dependency 'dry-monads', '~> 1.0'
   spec.add_dependency 'dry-configurable', '~> 0.7.0'
   spec.add_dependency 'http', '>= 2.0.3'
   spec.add_dependency 'hashie', '~> 3.5', '>= 3.5.6'

data/lib/api_struct.rb

@@ -1,5 +1,5 @@
 require 'http'
-require 'dry-monads'
+require 'dry/monads/result'
 require 'dry-configurable'
 require 'json'
 require 'hashie'

data/lib/api_struct/client.rb

@@ -1,8 +1,8 @@
 module ApiStruct
   class Client
-    DEFAULT_HEADERS = { 
+    DEFAULT_HEADERS = {
       'Accept': 'application/json',
-      'Content-Type': 'application/json' 
+      'Content-Type': 'application/json'
     }
     URL_OPTION_REGEXP = /\/:([a-z_]+)/.freeze
 
@@ -47,12 +47,12 @@ module ApiStruct
     def success(response)
       body = response.body.to_s
       result = !body.empty? ? JSON.parse(body, symbolize_names: true) : nil
-      Dry::Monads.Right(result)
+      Dry::Monads::Success(result)
     end
 
     def failure(response)
       result = ApiStruct::Errors::Client.new(response)
-      Dry::Monads.Left(result)
+      Dry::Monads::Failure(result)
     end
 
     def first_arg(args)

data/lib/api_struct/extensions/dry_monads.rb

@@ -2,16 +2,20 @@ module ApiStruct
   module Extensions
     module DryMonads
       def from_monad(monad)
-        monad.fmap { |v| from_right(v) }.or_fmap { |e| from_left(e) }.value
+        monad
+          .fmap { |v| from_success(v) }.or_fmap { |e| from_failure(e) }.value!
       end
 
-      def from_right(value)
-        return Dry::Monads::Right(nil) if value.nil?
+      def from_success(value)
+        return Dry::Monads::Success(nil) if value.nil?
+
         value.is_a?(Array) ? collection(value) : new(value)
       end
 
-      def from_left(error)
-        ApiStruct::Errors::Entity.new({ status: error.status, body: error.body, error: true }, false)
+      def from_failure(error)
+        ApiStruct::Errors::Entity.new(
+          { status: error.status, body: error.body, error: true }, false
+        )
       end
     end
   end

data/lib/api_struct/version.rb

@@ -1,3 +1,3 @@
 module ApiStruct
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/spec/api_struct/client_spec.rb

@@ -9,7 +9,7 @@ describe ApiStruct::Client do
     def show(id)
       get(id)
     end
-    
+
     def update(id, params)
       patch(id, json: params)
     end
@@ -61,8 +61,8 @@ describe ApiStruct::Client do
       VCR.use_cassette('users/1/posts') do
         response = StubClient.new.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
+        expect(response.value!).to be_kind_of Array
+        expect(response.value!).not_to be_empty
       end
     end
 
@@ -70,9 +70,9 @@ describe ApiStruct::Client do
       VCR.use_cassette('todos') do
         response = StubClient.new.get(path: 'todos/1')
         expect(response).to be_success
-        expect(response.value[:id]).to eq(1)
-        expect(response.value[:title]).not_to be_empty
-        expect(response.value.keys).to include(:completed)
+        expect(response.value![:id]).to eq(1)
+        expect(response.value![:title]).not_to be_empty
+        expect(response.value!.keys).to include(:completed)
       end
     end
 
@@ -80,20 +80,20 @@ describe ApiStruct::Client do
       VCR.use_cassette('todos') do
         response = StubClient.new.get(path: [:todos, 1])
         expect(response).to be_success
-        expect(response.value[:id]).to eq(1)
-        expect(response.value[:title]).not_to be_empty
-        expect(response.value.keys).to include(:completed)
+        expect(response.value![:id]).to eq(1)
+        expect(response.value![:title]).not_to be_empty
+        expect(response.value!.keys).to include(:completed)
       end
     end
   end
-  
+
   context 'GET' do
     it 'when successful response' do
       VCR.use_cassette('posts/show_success') do
         response = StubClient.new.show(1)
         expect(response).to be_success
-        expect(response.value[:id]).to eq(1)
-        expect(response.value[:title]).not_to be_empty
+        expect(response.value![:id]).to eq(1)
+        expect(response.value![:title]).not_to be_empty
       end
     end
 
@@ -101,7 +101,7 @@ describe ApiStruct::Client do
       VCR.use_cassette('posts/show_failure') do
         response = StubClient.new.show(101)
         expect(response).to be_failure
-        expect(response.value.status).to eq(404)
+        expect(response.failure.status).to eq(404)
       end
     end
   end
@@ -111,7 +111,7 @@ describe ApiStruct::Client do
       VCR.use_cassette('posts/update_success') do
         response = StubClient.new.update(1, title: FFaker::Name.name)
         expect(response).to be_success
-        expect(response.value[:id]).to eq(1)
+        expect(response.value![:id]).to eq(1)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - bezrukavyi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -220,7 +221,6 @@ files:
 - api_struct.svg
 - bin/console
 - bin/setup
-- circle.yml
 - lib/api_struct.rb
 - lib/api_struct/client.rb
 - lib/api_struct/collection.rb

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.4.2