api-model 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d62e3abae3a9c3844eeaa606a37263f57d096057
-  data.tar.gz: 1cc5a013afbc09fb71f12cded4e9ed6aeb8f5be6
+  metadata.gz: 6909e3c913be60c743cfef5babb4dadbe0852ece
+  data.tar.gz: db89536d66181112df8fbf7e5ab0589f37f3c56b
 SHA512:
-  metadata.gz: ebd2bc0b6ff25732cfac277f91888c908073970bce8eec68be7c59e7b3edc20ccb3abba66e8bc1deb8b0a7c398c0f84f704bf2c6e0e889be3df991828a9d58e2
-  data.tar.gz: 3b2df71ea9b2fddc4c220f4c4281c62bd2c45c8ac10fc2f22d92e96972287120a27cd078c8cd79e202c9820c32400de143767d6b398ff8f643fed90a55d75a1b
+  metadata.gz: 2ae38b790d32233392a537d88cd152f39332e69fa46ae160fb1b40ac9397d8178ed379f3e459650c8a09d56ca6af61f5b1ec9e79273d5ea8f352aad23e0121f8
+  data.tar.gz: 8c2a47a297bf712bfc3e782b55b342d9de0d311d6a9f6128358c845ba0a6678d8b12487211f4010b7829e264b9059c7891112b92fa6a3da573b837c1e515af8a

data/Gemfile.lock

@@ -1,44 +1,50 @@
 PATH
   remote: .
   specs:
-    api-model (1.1.2)
-      activemodel (~> 4.0)
-      activesupport (~> 4.0)
+    api-model (2.0.0)
+      activemodel (~> 4.1)
+      activesupport (~> 4.1)
       hash-pipe (~> 0.0)
-      hashie (~> 2.0)
       typhoeus (~> 0.6)
+      virtus (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.0.3)
-      activesupport (= 4.0.3)
-      builder (~> 3.1.0)
-    activesupport (4.0.3)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
+      tzinfo (~> 1.1)
     addressable (2.3.5)
-    atomic (1.1.15)
-    builder (3.1.4)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
     coderay (1.0.9)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    ethon (0.6.3)
+    equalizer (0.0.9)
+    ethon (0.7.0)
       ffi (>= 1.3.0)
-      mime-types (~> 1.18)
     ffi (1.9.3)
     hash-pipe (0.0.1)
       activesupport (~> 4.0)
-    hashie (2.0.5)
     i18n (0.6.9)
+    ice_nine (0.11.0)
+    json (1.8.1)
     method_source (0.8.2)
-    mime-types (1.25.1)
-    minitest (4.7.5)
-    multi_json (1.8.4)
+    minitest (5.3.2)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -53,12 +59,17 @@ GEM
     rspec-mocks (2.14.4)
     safe_yaml (0.9.7)
     slop (3.4.6)
-    thread_safe (0.2.0)
-      atomic (>= 1.1.7, < 2)
-    typhoeus (0.6.7)
-      ethon (~> 0.6.2)
-    tzinfo (0.3.38)
+    thread_safe (0.3.3)
+    typhoeus (0.6.8)
+      ethon (>= 0.7.0)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
     vcr (2.8.0)
+    virtus (1.0.2)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0.3)
+      equalizer (~> 0.0.9)
     webmock (1.15.0)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)

data/README.md

@@ -12,11 +12,11 @@ A really simple example
 
 To turn any class into an API model, it must inherit ApiModel::Base. If you want to
 make attributes which will get automatically set from api responses, you can define them
-as properties..
+as attributes..
 
 ``` ruby
   class MyModel < ApiModel::Base
-    property :name
+    attribute :name, String
   end
 ```
 
@@ -47,46 +47,27 @@ or you can send other request types:
   call_api :put, url, options
 ```
 
-Model properties
+Model attributes
 ----------------
 
-The properties which you can define on models are extended from the [Hashie](https://github.com/intridea/hashie#trash)
-gem. You can use them to define simple attributes, but also for converting attributes from one name to another, or for
-transforming the values as they are set. This is useful for dealing with APIs which use a different naming scheme
-than you are using, or if you need to modify values as they come in.
+The attributes which you can define on models are included from the [Virtus](https://github.com/solnic/virtus)
+gem. You can use them to define simple attributes, coercing values as they come in, or just type-casting. Be sure
+to check out the Virtus docs for more info on what can be achieved.
 
-### Translation
+To make it easier to work with APIs which have different naming schemes from your models, you can define attribute
+synonyms, which are really just simple aliases.
 
-```ruby
-  class MyModel < ApiModel::Base
-    property :full_name, from: :fullName
-  end
-
-  MyModel.new(fullName: "Hello").full_name # => "Hello"
-```
-
-### Transformation
-
-```ruby
-  class MyModel < ApiModel::Base
-    property :created_at, from: :timestamp, with: lambda { |t| Time.at(t) }
-  end
-
-  MyModel.new(timestamp: 1387550991).created_at # => 2013-12-20 15:49:51 +0100
-```
-
-### Defaults
+For example, say you have a `Car` model which has a `number_of_wheels` attribute but with the APIs you're using, sometimes
+it the attribute is named `numberOfWheels`, sometimes it's `nrOfWheels` and sometimes it's `wheel_count`, you can easily handle
+them all at once:
 
 ```ruby
-  class MyModel < ApiModel::Base
-    property :name, default: "FooBar"
+  class Car < ApiModel::Base
+    attribute :number_of_wheels, Integer
+    attribute_synonym :number_of_wheels, :numberOfWheels, :nrOfWheels, :wheel_count
   end
-
-  MyModel.new.name # => "FooBar"
 ```
 
-For more information, check out the [Hashie::Trash docs](https://github.com/intridea/hashie#trash).
-
 Building objects from responses
 -------------------------------
 
@@ -124,7 +105,7 @@ ActiveModel validations, you can do that, too:
 
 ```ruby
   class Car
-    property :name
+    attribute :name, String
   end
 
   car = Car.new

data/api-model.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "api-model"
-  s.version     = "1.1.2"
+  s.version     = "2.0.0"
   s.authors     = ["Damien Timewell"]
   s.email       = ["mail@damientimewell.com"]
   s.licenses    = ['MIT']
@@ -10,10 +10,10 @@ Gem::Specification.new do |s|
   s.summary     = "A simple way of interacting with rest APIs"
   s.description = "API model is a simple wrapper for interacting with external APIs. It tries to make it very simple and easy to make API calls and map the responses into objects."
 
-  s.add_dependency 'activesupport', '~> 4.0'
-  s.add_dependency 'activemodel', '~> 4.0'
+  s.add_dependency 'activesupport', '~> 4.1'
+  s.add_dependency 'activemodel', '~> 4.1'
   s.add_dependency 'typhoeus', '~> 0.6'
-  s.add_dependency 'hashie', '~> 2.0'
+  s.add_dependency 'virtus', '~> 1.0'
   s.add_dependency 'hash-pipe', '~> 0.0'
 
   s.add_development_dependency "rspec", '~> 2.14'

data/lib/api-model.rb

@@ -2,14 +2,11 @@ require 'active_model'
 require 'active_support'
 require 'active_support/core_ext'
 require 'logger'
-require 'hashie'
+require 'virtus'
 require 'typhoeus'
 require 'ostruct'
 require 'hash-pipe'
 
-require 'api_model/core_extensions/hash'
-require 'api_model/core_extensions/hashie'
-
 require 'api_model/assignment'
 require 'api_model/initializer'
 require 'api_model/http_request'
@@ -38,7 +35,9 @@ module ApiModel
     end
   end
 
-  class Base < Hashie::Trash
+  class Base
+    include Virtus.model
+
     include ActiveModel::Conversion
     include ActiveModel::Validations
     include ActiveModel::Serialization

data/lib/api_model/class_methods.rb

@@ -1,6 +1,13 @@
 module ApiModel
   module ClassMethods
 
+    # TODO - try to think of a more memorable name for this...
+    def attribute_synonym(primary_method_name, *alternate_names)
+      alternate_names.each do |alternate_name|
+        alias_method "#{alternate_name}=".to_sym, "#{primary_method_name}=".to_sym
+      end
+    end
+
     def get_json(path, params={}, options={})
       call_api :get, path, options.merge(params: params)
     end

data/lib/api_model/instance_methods.rb

@@ -6,18 +6,10 @@ module ApiModel
       extend ActiveModel::Callbacks
       define_model_callbacks :save, :successful_save, :unsuccessful_save
 
-      property :persisted, default: false
+      attribute :persisted, Axiom::Types::Boolean, default: false
       alias_method :persisted?, :persisted
     end
 
-    # Overrides Hashie::Trash to catch errors from trying to set properties which have not been defined
-    # and defines it automatically
-    def property_exists?(property_name)
-      super property_name
-    rescue NoMethodError
-      Log.debug "Could not set #{property_name} on #{self.class.name}"
-    end
-
     # Convenience method to handle error hashes and set them as ActiveModel errors on instances.
     # Using the `obj`, you can move the errors on to child classes if needed.
     def set_errors_from_hash(errors_hash, obj = self)
@@ -70,11 +62,11 @@ module ApiModel
       end
     end
 
-    # Returns all the defined properties in a hash without the :persisted property which was added automatically.
+    # Returns all the defined attributes in a hash without the :persisted attribute which was added automatically.
     #
     # This is useful for when you need to pass the entire object back to an API, or if you want to serialize the object.
     def properties_hash
-      self.to_hash.only(*self.class.properties.to_a).except(:persisted).with_indifferent_access
+      self.to_hash.only(*self.class.attribute_set.collect(&:name)).except(:persisted).with_indifferent_access
     end
 
   end

data/spec/api-model/api_model_spec.rb

@@ -65,7 +65,7 @@ describe ApiModel do
     end
   end
 
-  describe "using Hashie to build with properties" do
+  describe "using Virtus to build with attribute coercion" do
     describe "with a single object response" do
       let :car do
         VCR.use_cassette('cars') { Car.get_json "http://cars.com/one_convertable" }
@@ -121,6 +121,23 @@ describe ApiModel do
     end
   end
 
+  describe "defining attribute synonyms" do
+    let(:car) { Car.new }
+
+    it 'should have defined method aliases for numberOfDoors and nrOfDoors' do
+      car.numberOfDoors = 10
+      car.number_of_doors.should eq 10
+
+      car.nrOfDoors = 20
+      car.number_of_doors.should eq 20
+    end
+
+    it 'should still use Virtus coersion when using an alias' do
+      car.max_speed = 10
+      car.top_speed.should eq 100 # the coersion is doing * 10
+    end
+  end
+
   describe "setting errors from a hash" do
     let(:car) { Car.new }
     let(:blog_post) { BlogPost.new }
@@ -281,12 +298,6 @@ describe ApiModel do
     end
   end
 
-  describe "class equality" do
-    it 'should not be equal to a Hash even though it is technically a Hash subclass' do
-      (Hash === BlogPost.new).should be_false
-    end
-  end
-
   describe "properties_hash" do
     let(:blog_post) { BlogPost.new title: "Foo", name: "Bar", something_else: "Baz" }
 
@@ -303,7 +314,7 @@ describe ApiModel do
       blog_post.properties_hash.should_not have_key(:something_else)
     end
 
-    it 'should not include the :persisted property, even though it is defined' do
+    it 'should not include the :persisted attribute, even though it is defined' do
       blog_post.properties_hash.should_not have_key(:persisted)
     end
   end

data/spec/support/mock_models/banana.rb

@@ -1,5 +1,5 @@
 class Banana < ApiModel::Base
-  property :color
-  property :size
-  property :ripe
+  attribute :color, String
+  attribute :size, String
+  attribute :ripe, Boolean
 end

data/spec/support/mock_models/blog_post.rb

@@ -1,6 +1,6 @@
 class BlogPost < ApiModel::Base
-  property :name
-  property :title
+  attribute :name, String
+  attribute :title, String
 
   class CustomBuilder
     def build(hash)

data/spec/support/mock_models/car.rb

@@ -1,8 +1,16 @@
+class CarTopSpeed < Virtus::Attribute
+  def coerce(value)
+    value * 10 if value
+  end
+end
+
 class Car < ApiModel::Base
+  attribute :number_of_doors, Integer
+  attribute :top_speed, CarTopSpeed
+  attribute :name, String, default: "Ferrari"
 
-  property :number_of_doors, from: :numberOfDoors
-  property :top_speed, transform_with: lambda { |speed| speed * 10 }
-  property :name, default: "Ferrari"
+  attribute_synonym :number_of_doors, :numberOfDoors, :nrOfDoors
+  attribute_synonym :top_speed, :max_speed
 
   def is_fast?
     top_speed > 300

data/spec/support/mock_models/user.rb

@@ -1,4 +1,4 @@
 class User < ApiModel::Base
-  property :name
-  property :email_address
+  attribute :name, String
+  attribute :email_address, String
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: api-model
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: virtus
   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: hash-pipe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
@@ -145,9 +145,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -158,8 +158,6 @@ files:
 - lib/api_model/cache_stategy/no_cache.rb
 - lib/api_model/class_methods.rb
 - lib/api_model/configuration.rb
-- lib/api_model/core_extensions/hash.rb
-- lib/api_model/core_extensions/hashie.rb
 - lib/api_model/http_request.rb
 - lib/api_model/initializer.rb
 - lib/api_model/instance_methods.rb
@@ -191,12 +189,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/lib/api_model/core_extensions/hash.rb

@@ -1,16 +0,0 @@
-# When using ApiModel in a Rails application, Rails will try to ascertain what type of class
-# an instance of ApiModel::Base is when attempting to build a polymorphic route. Since ApiModel::Base
-# inherits from Hashie, which in turn inherits from Hash, Rails thinks that an instance of
-# ApiModel::Base is in fact a hash instead of acting like an ActiveModel, which then causes
-# it to fail to compute a route for the class.
-#
-# This is a hacky workaround, but should not interfere with any core functionality since it just
-# calls super if the class is not a subclass of ApiModel::Base.
-Hash.class_eval do
-
-  def self.===(klass)
-    return false if klass.class.ancestors.include? ApiModel::Base
-    super klass
-  end
-
-end

data/lib/api_model/core_extensions/hashie.rb

@@ -1,8 +0,0 @@
-Hashie::Dash.class_eval do
-
-  # Prevent hashie from raising errors when trying to set properties which have not been defined.
-  def assert_property_exists!(property)
-    super rescue NoMethodError
-  end
-
-end