jeckle 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 187c3bfe2db7cab76746126db6fbf418de6068d087adeb0c817d2ded6f1d4462
-  data.tar.gz: e2aa04caf4838dd135c1c4cb9a70db7429975466fa3db37cf4745a6febba541d
+  metadata.gz: 4761ead36774dc1acab1c41b0365ff229c412677a75292aa1473acd381fd06cd
+  data.tar.gz: 64f4f522c235470e25be1660a414bebf5aabe81e4b60e934b1fcbd13ed08056b
 SHA512:
-  metadata.gz: 5ce3a1792ce54a89573a6a0be1a72d85f4381f7542883847ff0b7e5200309ec9388b2dfb45923e5133aa0c3c1c83b81e2df78030a276bbc83d07869699a9ff57
-  data.tar.gz: 3f181d2afe18db62be11d4d5faffa47c1e1f4532029d7704d46cf2b29969e1b15bd63ce18563ccad8c5c3796fab2cd9a504a5c77478917c24a2337a55661614f
+  metadata.gz: 94176cba14e8fa3ad4aac3006191f34dffc050ca6739a05e991715108f8a9a8b4e6abb9e937028e3230357b6a39146f015a8484fc29a8a987e5dab8d43ae0508
+  data.tar.gz: 719608cb95326167d652fd67fa76ceac3929ba4610a1705e4ad948c769d97177f3eaa161907e7396ade56cc32368fe0b625e9be043ae6884529a15adc200b9b3

data/README.md

@@ -52,21 +52,19 @@ end
 Following the previous example, Dribbble.com consists of pieces of web designers work called "Shots". Each shot has the attributes `id`, `name`, `url` and `image_url`. A Jeckle resource representing Dribbble's shots would be something like this:
 
 ```ruby
-class Shot
-  include Jeckle::Resource
-
+class Shot < Jeckle::Resource
   api :dribbble
 
-  attribute :id, Integer
-  attribute :name, String
-  attribute :url, String
-  attribute :image_url, String
+  attribute :id, Jeckle::Types::Integer
+  attribute :name, Jeckle::Types::String
+  attribute :url, Jeckle::Types::String
+  attribute :image_url, Jeckle::Types::String
 end
 ```
 
 ### Fetching data
 
-The resource class allows us to search shots through HTTP requests to the API, based on the provided information. For example, we can find a specific shot by providing its id to the `find` method:
+The resource class allows us to list shots through HTTP requests to the API, based on the provided information. For example, we can find a specific shot by providing its id to the `find` method:
 
 ```ruby
 # GET http://api.dribbble.com/shots/1600459
@@ -86,11 +84,11 @@ shot.image_url
 => "https://d13yacurqjgara.cloudfront.net/users/85699/screenshots/1600459/daryl_heckle_and_jeckle_oates-dribble.jpg"
 ```
 
-You can also look for many shots matching one or more attributes, by using the `search` method:
+You can also look for many shots matching one or more attributes, by using the `list` method:
 
 ```ruby
 # GET http://api.dribbble.com/shots?name=avengers
-shots = Shot.search name: 'avengers'
+shots = Shot.list name: 'avengers'
 ```
 
 ### Attribute Aliasing
@@ -98,7 +96,7 @@ shots = Shot.search name: 'avengers'
 Sometimes you want to call the API's attributes something else, either because their names aren't very concise or because they're out of you app's convention. If that's the case, you can add an `as` option:
 
 ```ruby
-attribute :thumbnailSize, String, as: :thumbnail_size
+attribute :thumbnailSize, Jeckle::Types::String, as: :thumbnail_size
 ```
 
 Both mapping will work:
@@ -111,8 +109,6 @@ shot.thumbnail_size
 => "50x50"
 ```
 
-We're all set! Now we can expand the mapping of our API, e.g to add ability to search Dribbble Designer directory by adding Designer class, or we can expand the original mapping of Shot class to include more attributes, such as tags or comments.
-
 ### Error Handling
 
 Jeckle provides a built-in Faraday middleware that automatically raises typed errors for HTTP error responses. Enable it in your API configuration:
@@ -156,6 +152,50 @@ The error hierarchy:
     - `Jeckle::ServerError` — 5xx errors
       - `InternalServerError` (500), `ServiceUnavailableError` (503)
 
+We're all set! Now we can expand the mapping of our API, e.g to add ability to search Dribbble Designer directory by adding Designer class, or we can expand the original mapping of Shot class to include more attributes, such as tags or comments.
+
+## Migration from 0.4.x
+
+### Resource definition
+
+Resources now use class inheritance instead of module inclusion:
+
+```ruby
+# Before (0.4.x)
+class Shot
+  include Jeckle::Resource
+  attribute :id, Integer
+end
+
+# After (0.6.0+)
+class Shot < Jeckle::Resource
+  attribute :id, Jeckle::Types::Integer
+end
+```
+
+### Attribute types
+
+Use `Jeckle::Types::*` instead of Ruby constants:
+
+| Before | After |
+|--------|-------|
+| `Integer` | `Jeckle::Types::Integer` |
+| `String` | `Jeckle::Types::String` |
+| `Float` | `Jeckle::Types::Float` |
+| `Boolean` | `Jeckle::Types::Bool` |
+
+### Collection method
+
+The `search` method has been renamed to `list`:
+
+```ruby
+# Before
+Shot.search name: 'avengers'
+
+# After
+Shot.list name: 'avengers'
+```
+
 ## Examples
 
 You can see more examples here: [https://github.com/tomas-stefano/jeckle/tree/master/examples](https://github.com/tomas-stefano/jeckle/tree/master/examples)

data/lib/jeckle/attribute_aliasing.rb

@@ -2,14 +2,26 @@
 
 module Jeckle
   module AttributeAliasing
-    def attribute(name, coercion, options = {})
+    def attribute(name, type = nil, **options)
       if (custom_name = options.delete(:as))
-        super(custom_name, coercion, options)
+        original_name = name
 
-        alias_method name, custom_name
-        alias_method :"#{name}=", :"#{custom_name}="
+        if type
+          super(custom_name, type)
+        else
+          super(custom_name)
+        end
+
+        define_method(original_name) { public_send(custom_name) }
+
+        transform_keys do |key|
+          key = key.to_sym
+          key == original_name ? custom_name : key
+        end
+      elsif type
+        super(name, type)
       else
-        super
+        super(name)
       end
     end
   end

data/lib/jeckle/http.rb

@@ -2,38 +2,26 @@
 
 module Jeckle
   module HTTP
-    def self.included(base)
-      base.extend Jeckle::HTTP::APIMapping
-    end
-
     module APIMapping
       def inherited(base)
-        base.class_eval do
-          @api_mapping = superclass.api_mapping.dup
-        end
+        super
+        base.instance_variable_set(:@api_mapping, api_mapping.dup)
       end
 
       # The name of the resource that Jeckle uses to make the request
       #
       # @example
       #
-      #   module Dribble
-      #     class Shot
-      #       include Jeckle::Resource
-      #     end
+      #   class Shot < Jeckle::Resource
       #   end
       #
       #   Shot.resource_name # => Will request for '/shots' resource
       #
       # To overwrite this behaviour, rewrite the resource name method in the class:
       #
-      #   module OtherApi
-      #     class Project
-      #       include Jeckle::Resource
-      #
-      #       def self.resource_name
-      #         '/project'
-      #       end
+      #   class Project < Jeckle::Resource
+      #     def self.resource_name
+      #       '/project'
       #     end
       #   end
       #
@@ -51,8 +39,7 @@ module Jeckle
       #     end
       #   end
       #
-      #   class Shot
-      #     include Jeckle::Resource
+      #   class Shot < Jeckle::Resource
       #     api :dribbble
       #   end
       #

data/lib/jeckle/model.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Jeckle
-  module Model
-    def self.included(base)
-      base.include ActiveModel::Validations
-      base.include Virtus.model
-    end
+  class Model < Dry::Struct
+    transform_keys(&:to_sym)
+    transform_types(&:omittable)
+
+    include ActiveModel::Validations
   end
 end

data/lib/jeckle/resource.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
 module Jeckle
-  module Resource
-    def self.included(base)
-      base.include ActiveModel::Naming
+  class Resource < Jeckle::Model
+    include ActiveModel::Naming
 
-      base.include Jeckle::Model
-      base.include Jeckle::HTTP
-      base.include Jeckle::RESTActions
-
-      base.extend Jeckle::AttributeAliasing
-    end
+    extend Jeckle::HTTP::APIMapping
+    extend Jeckle::RESTActions::Collection
+    extend Jeckle::AttributeAliasing
   end
 end

data/lib/jeckle/rest_actions.rb

@@ -2,10 +2,6 @@
 
 module Jeckle
   module RESTActions
-    def self.included(base)
-      base.extend Jeckle::RESTActions::Collection
-    end
-
     module Collection
       def find(id)
         endpoint = "#{resource_name}/#{id}"
@@ -14,7 +10,7 @@ module Jeckle
         new attributes
       end
 
-      def search(params = {})
+      def list(params = {})
         custom_resource_name = params.delete(:resource_name) if params.is_a?(Hash)
 
         response   = run_request(custom_resource_name || resource_name, params: params).response.body || []
@@ -22,6 +18,11 @@ module Jeckle
 
         Array(collection).collect { |attrs| new attrs }
       end
+
+      def search(params = {})
+        warn '[DEPRECATION] `search` is deprecated. Please use `list` instead.'
+        list(params)
+      end
     end
   end
 end

data/lib/jeckle/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jeckle
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/jeckle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jeckle
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/jeckle.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require 'active_model'
+require 'dry-struct'
+require 'dry/types'
 require 'faraday'
-require 'virtus'
 
 require 'jeckle/version'
 
 %w[
-  setup api model request http rest_actions resource errors attribute_aliasing
+  types setup api model request http rest_actions attribute_aliasing resource errors
   middleware/raise_error
 ].each do |file_name|
   require "jeckle/#{file_name}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeckle
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tomas D'Stefano
@@ -26,33 +26,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: virtus
+  name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,7 @@ files:
 - lib/jeckle/resource.rb
 - lib/jeckle/rest_actions.rb
 - lib/jeckle/setup.rb
+- lib/jeckle/types.rb
 - lib/jeckle/version.rb
 homepage: https://github.com/tomas-stefano/jeckle
 licenses: