api-model 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e80eb51e30b3e5dacade8092adb4e6160224ab4
-  data.tar.gz: 91c1d13d150318c136d49c16f19aaa8d491234c6
+  metadata.gz: 75b2ddb171371b895e8ecf655cfd69a56368738b
+  data.tar.gz: a0165241ef3855d10e044d9cdc8b821e3114a6a9
 SHA512:
-  metadata.gz: f584b017ee477b3e5630c2cf73725f77cec863f1e42f522a548f01a1993e6e679f5d81d9c938df44e0ca934a5eed8cc8a037a6d8b94f7ac6aeb71b81c740a7f8
-  data.tar.gz: 031a973ad6b657c11bf5ea819a4b6dcf54cacaf56aa9838118cf3cb450aa4750aae41f8cc546cd92c7fd33397380d341c491d2cc132e0719f25122a0649acc02
+  metadata.gz: c377a0408bcc44930c807b07ef4274bf15ab5ddb6db7e790c421e39c8ec4dcfeaf71496c3fd0d57188c0d6821b32646a5b8c96dafdf8e9166ff4e00e34510fb4
+  data.tar.gz: 480a76b37a1800abcbccc9da0365cda8a8332af301e5e997d0b281a451403e7339a7a93433dd9ea814ca4b6113aa26b5fe287b1a5e2a3b8ff1e6aa6937cbd8a8

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec spec

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    api-model (0.0.1)
+    api-model (0.0.3)
       activemodel
       activesupport
+      hashie
       typhoeus
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.0.1)
-      activesupport (= 4.0.1)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
       builder (~> 3.1.0)
-    activesupport (4.0.1)
+    activesupport (4.0.2)
       i18n (~> 0.6, >= 0.6.4)
       minitest (~> 4.2)
       multi_json (~> 1.3)
@@ -29,7 +30,8 @@ GEM
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
     ffi (1.9.0)
-    i18n (0.6.5)
+    hashie (2.0.5)
+    i18n (0.6.9)
     method_source (0.8.2)
     mime-types (1.25.1)
     minitest (4.7.5)

data/README.md

@@ -1 +1,4 @@
+[![Code Climate](https://codeclimate.com/github/iZettle/api-model.png)](https://codeclimate.com/github/iZettle/api-model)
+[![Build Status](https://travis-ci.org/iZettle/api-model.png?branch=master)](https://travis-ci.org/iZettle/api-model)
+
 Api Model README

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     = "0.0.2"
+  s.version     = "0.0.3"
   s.authors     = ["Damien Timewell"]
   s.email       = ["mail@damientimewell.com"]
   s.homepage    = "https://github.com/iZettle/api-model"
@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport'
   s.add_dependency 'activemodel'
   s.add_dependency 'typhoeus'
+  s.add_dependency 'hashie'
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "pry"

data/lib/api-model.rb

@@ -2,42 +2,48 @@ require 'active_model'
 require 'active_support'
 require 'active_support/core_ext'
 require 'logger'
+require 'hashie'
 
 require 'api_model/initializer'
 require 'api_model/http_request'
 require 'api_model/response'
+require 'api_model/rest_methods'
+require 'api_model/configuration'
 
 module ApiModel
-
-  if defined? Rails
-    Log = Rails.logger
-  else
-    Log = Logger.new STDOUT
+  Log = Logger.new STDOUT
+
+  class ResponseBuilderError < StandardError; end
+  class UnauthenticatedError < StandardError; end
+  class NotFoundError < StandardError; end
+
+  if defined?(Rails)
+    class Railtie < Rails::Railtie
+      initializer "api-model" do
+        ApiModel.send :remove_const, :Log
+        ApiModel::Log = Rails.logger
+      end
+    end
   end
 
-  class Base
+  class Base < Hashie::Trash
     include ActiveModel::Conversion
     include ActiveModel::Validations
+    include ActiveModel::Serialization
     extend ActiveModel::Naming
     extend ActiveModel::Callbacks
 
-    include ApiModel::Initializer
+    extend RestMethods
+    include ConfigurationMethods
 
-    def self.api_host=(api_host)
-      @api_host = api_host
+    # 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}. Defining it now."
+      self.class.property property_name.to_sym
     end
-
-    def self.api_host
-      @api_host || ""
-    end
-
-    def self.get_json(path, options={})
-      # TODO - tidy this up...
-      builder = options.delete(:builder) || self
-      options[:api_host] = api_host
-
-      HttpRequest.run(options.merge(path: path)).build_objects builder
-    end
-
   end
+
 end

data/lib/api_model/configuration.rb

@@ -0,0 +1,39 @@
+module ApiModel
+  class Configuration
+    include Initializer
+
+    attr_accessor :host, :json_root, :headers, :raise_on_unauthenticated, :raise_on_not_found
+
+    def self.from_inherited_config(config)
+      new config.instance_values.reject {|k,v| v.blank? }
+    end
+
+    def headers
+      @headers ||= {}
+      @headers.reverse_merge "Content-Type" => "application/json; charset=utf-8",  "Accept" => "application/json"
+    end
+  end
+
+  module ConfigurationMethods
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def reset_api_configuration
+        @_api_config = nil
+      end
+
+      def api_model_configuration
+        @_api_config || superclass.api_model_configuration
+      rescue
+        @_api_config = Configuration.new
+      end
+
+      def api_config
+        @_api_config = Configuration.from_inherited_config api_model_configuration
+        yield @_api_config
+      end
+
+    end
+  end
+end

data/lib/api_model/http_request.rb

@@ -2,15 +2,17 @@ module ApiModel
   class HttpRequest
     include ApiModel::Initializer
 
-    attr_accessor :path, :method, :options, :api_call, :api_host
+    attr_accessor :path, :method, :options, :api_call, :builder, :config
 
-    def self.run(options={})
-      self.new(options).run
-    end
+    after_initialize :set_default_options
+
+    define_model_callbacks :run
 
     def run
-      self.api_call = Typhoeus.send(method, full_path, options)
-      Response.new self.api_call
+      run_callbacks :run do
+        self.api_call = Typhoeus.send method, full_path, options
+        Response.new self, config
+      end
     end
 
     def method
@@ -23,7 +25,18 @@ module ApiModel
 
     def full_path
       return path if path =~ /^http/
-      "#{api_host}#{path}"
+      "#{config.host}#{path}"
+    end
+
+    def request_method
+      api_call.request.original_options[:method]
+    end
+
+    private
+
+    def set_default_options
+      options[:headers] ||= {}
+      options[:headers].reverse_merge! config.headers if config.try(:headers)
     end
 
   end

data/lib/api_model/initializer.rb

@@ -1,9 +1,10 @@
 module ApiModel
   module Initializer
+    extend ActiveSupport::Concern
 
-    def self.included(klass)
-      klass.extend ActiveModel::Callbacks
-      klass.define_model_callbacks :initialize
+    included do
+      extend ActiveModel::Callbacks
+      define_model_callbacks :initialize
     end
 
     def initialize(values={})

data/lib/api_model/response.rb

@@ -9,16 +9,20 @@ module ApiModel
 
     attr_accessor :http_response, :objects
 
-    def initialize(http_response)
+    def initialize(http_response, config)
       @http_response = http_response
+      @_config = config || Configuration.new
     end
 
-    # TODO - make json root configurable
-    def build_objects(builder)
-      if json_response_body.is_a? Array
-        self.objects = json_response_body.collect{ |hash| build builder, hash }
-      elsif json_response_body.is_a? Hash
-        self.objects = self.build builder, json_response_body
+    def build_objects
+      raise UnauthenticatedError if @_config.raise_on_unauthenticated && http_response.api_call.response_code == 401
+      raise NotFoundError if @_config.raise_on_not_found && http_response.api_call.response_code == 404
+      return if json_response_body.nil?
+
+      if response_build_hash.is_a? Array
+        self.objects = response_build_hash.collect{ |hash| build http_response.builder, hash }
+      elsif response_build_hash.is_a? Hash
+        self.objects = self.build http_response.builder, response_build_hash
       end
 
       self
@@ -33,9 +37,9 @@ module ApiModel
     end
 
     def json_response_body
-      JSON.parse http_response.body
+      @json_response_body ||= JSON.parse http_response.api_call.body
     rescue JSON::ParserError
-      Log.info "Could not parse JSON response: #{http_response.body}"
+      Log.info "Could not parse JSON response: #{http_response.api_call.body}"
       return nil
     end
 
@@ -53,5 +57,26 @@ module ApiModel
       objects.send method_name, *args, &block
     end
 
+    private
+
+    # If the model config defines a json root, use it on the json_response_body
+    # to dig down in to the hash.
+    #
+    # The root for a deeply nested hash will come in as a string with key names split
+    # with a colon.
+    def response_build_hash
+      if @_config.json_root.present?
+        begin
+          @_config.json_root.split(".").inject(json_response_body) do |hash,key|
+            hash.fetch(key)
+          end
+        rescue
+          raise ResponseBuilderError, "Could not find key #{@_config.json_root} in:\n#{json_response_body}"
+        end
+      else
+        json_response_body
+      end
+    end
+
   end
 end

data/lib/api_model/rest_methods.rb

@@ -0,0 +1,21 @@
+module ApiModel
+  module RestMethods
+
+    def get_json(path, params={}, options={})
+      call_api :get, path, options.merge(params: params)
+    end
+
+    def post_json(path, body=nil, options={})
+      body = body.to_json if body.is_a?(Hash)
+      call_api :post, path, options.merge(body: body)
+    end
+
+    def call_api(method, path, options={})
+      request = HttpRequest.new path: path, method: method, config: api_model_configuration
+      request.builder = options.delete(:builder) || self
+      request.options.merge! options
+      request.run.build_objects
+    end
+
+  end
+end

data/spec/api-model/api_model_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'support/mock_models/blog_post'
+require 'support/mock_models/car'
+
+describe ApiModel do
+
+  describe "sending different types of requests" do
+    before do
+      BlogPost.api_config do |config|
+        config.host = "http://api-model-specs.com"
+      end
+    end
+
+    it "should be possible to send a GET request" do
+      get_request = VCR.use_cassette('posts') { BlogPost.get_json "/single_post" }
+      get_request.http_response.request_method.should eq :get
+    end
+
+    it "should be possible to send a POST request" do
+      post_request = VCR.use_cassette('posts') { BlogPost.post_json "/posts" }
+      post_request.http_response.request_method.should eq :post
+    end
+
+    it 'should be possible to send a POST request with a hash as body' do
+      post_request = VCR.use_cassette('posts') { BlogPost.post_json "/create_with_json", name: "foobarbaz" }
+      post_request.http_response.api_call.request.options[:body].should eq "{\"name\":\"foobarbaz\"}"
+    end
+  end
+
+  describe "retrieving a single object" do
+    describe "with the default builder" do
+      let(:blog_post) do
+        VCR.use_cassette('posts') do
+          BlogPost.get_json "http://api-model-specs.com/single_post"
+        end
+      end
+
+      it "should run the request and objectify the response hash" do
+        blog_post.should be_a(BlogPost)
+        blog_post.name.should eq "foo"
+      end
+    end
+
+    describe "with a custom builder" do
+      let(:custom_built_blog_post) do
+        VCR.use_cassette('posts') do
+          BlogPost.get_json "http://api-model-specs.com/single_post", {}, builder: BlogPost::CustomBuilder.new
+        end
+      end
+
+      it "should be possible to use a custom builder class when objectifing" do
+        custom_built_blog_post.should be_a(BlogPost)
+        custom_built_blog_post.title.should eq "FOOBAR"
+      end
+    end
+  end
+
+  describe "using Hashie to build with properties" do
+    describe "with a single object response" do
+      let :car do
+        VCR.use_cassette('cars') { Car.get_json "http://cars.com/one_convertable" }
+      end
+
+      it 'should build the correct object' do
+        car.should be_a(Car)
+      end
+
+      it 'should correctly rename properties' do
+        car.number_of_doors.should eq 2
+      end
+
+      it 'should correctly transform properties' do
+        car.top_speed.should eq 600
+      end
+
+      it 'should let you define custom methods as normal' do
+        car.is_fast?.should be_true
+      end
+
+      it 'should let you respect default values for properties' do
+        car.name.should eq "Ferrari"
+      end
+    end
+
+    describe "with a collection of objects response" do
+      let :cars do
+        VCR.use_cassette('cars') { Car.get_json "http://cars.com/fast_ones" }
+      end
+
+      it 'should build an array of the correct objects' do
+        cars.should be_a(Array)
+        cars.collect { |car| car.should be_a(Car) }
+      end
+
+      it 'should correctly rename properties' do
+        cars.last.number_of_doors.should eq 4
+      end
+
+      it 'should correctly transform properties' do
+        cars.last.top_speed.should eq 300
+      end
+
+      it 'should let you define custom methods as normal' do
+        cars.last.is_fast?.should be_false
+      end
+
+      it 'should respect default values for properties, but also override them' do
+        cars.first.name.should eq "Ferrari"
+        cars.last.name.should eq "Ford"
+      end
+    end
+
+    describe "with a single object which has properties which are undefined" do
+      let :new_car do
+        VCR.use_cassette('cars') { Car.get_json "http://cars.com/new_model" }
+      end
+
+      it "should not raise an exception" do
+        expect {
+          new_car
+        }.to_not raise_error
+      end
+
+      it 'should define the missing property on the fly' do
+        new_car.shiney.should eq true
+      end
+    end
+  end
+
+end