api-model 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e80eb51e30b3e5dacade8092adb4e6160224ab4
+  data.tar.gz: 91c1d13d150318c136d49c16f19aaa8d491234c6
+SHA512:
+  metadata.gz: f584b017ee477b3e5630c2cf73725f77cec863f1e42f522a548f01a1993e6e679f5d81d9c938df44e0ca934a5eed8cc8a037a6d8b94f7ac6aeb71b81c740a7f8
+  data.tar.gz: 031a973ad6b657c11bf5ea819a4b6dcf54cacaf56aa9838118cf3cb450aa4750aae41f8cc546cd92c7fd33397380d341c491d2cc132e0719f25122a0649acc02

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+*.gem
+.idea
+*.iml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    api-model (0.0.1)
+      activemodel
+      activesupport
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.0.9)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.5)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    ffi (1.9.0)
+    i18n (0.6.5)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    slop (3.4.6)
+    thread_safe (0.1.3)
+      atomic
+    typhoeus (0.6.5)
+      ethon (~> 0.6.1)
+    tzinfo (0.3.38)
+    vcr (2.8.0)
+    webmock (1.15.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api-model!
+  pry
+  rspec
+  vcr
+  webmock (= 1.15.0)

data/README.md

@@ -0,0 +1 @@
+Api Model README

data/api-model.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "api-model"
+  s.version     = "0.0.2"
+  s.authors     = ["Damien Timewell"]
+  s.email       = ["mail@damientimewell.com"]
+  s.homepage    = "https://github.com/iZettle/api-model"
+  s.summary     = "A simple way of interacting with rest APIs"
+  s.description = "A simple way of interacting with rest APIs"
+
+  # s.add_dependency 'redis'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'activemodel'
+  s.add_dependency 'typhoeus'
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock", "1.15.0"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+end

data/lib/api-model.rb

@@ -0,0 +1,43 @@
+require 'active_model'
+require 'active_support'
+require 'active_support/core_ext'
+require 'logger'
+
+require 'api_model/initializer'
+require 'api_model/http_request'
+require 'api_model/response'
+
+module ApiModel
+
+  if defined? Rails
+    Log = Rails.logger
+  else
+    Log = Logger.new STDOUT
+  end
+
+  class Base
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+    extend ActiveModel::Naming
+    extend ActiveModel::Callbacks
+
+    include ApiModel::Initializer
+
+    def self.api_host=(api_host)
+      @api_host = api_host
+    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/http_request.rb

@@ -0,0 +1,30 @@
+module ApiModel
+  class HttpRequest
+    include ApiModel::Initializer
+
+    attr_accessor :path, :method, :options, :api_call, :api_host
+
+    def self.run(options={})
+      self.new(options).run
+    end
+
+    def run
+      self.api_call = Typhoeus.send(method, full_path, options)
+      Response.new self.api_call
+    end
+
+    def method
+      @method ||= :get
+    end
+
+    def options
+      @options ||= {}
+    end
+
+    def full_path
+      return path if path =~ /^http/
+      "#{api_host}#{path}"
+    end
+
+  end
+end

data/lib/api_model/initializer.rb

@@ -0,0 +1,28 @@
+module ApiModel
+  module Initializer
+
+    def self.included(klass)
+      klass.extend ActiveModel::Callbacks
+      klass.define_model_callbacks :initialize
+    end
+
+    def initialize(values={})
+      run_callbacks :initialize do
+        update_attributes values
+      end
+    end
+
+    def update_attributes(values={})
+      return unless values.present?
+
+      values.each do |key,value|
+        begin
+          public_send "#{key}=", value
+        rescue
+          Log.debug "Could not set #{key} on #{self.class.name}"
+        end
+      end
+    end
+
+  end
+end

data/lib/api_model/response.rb

@@ -0,0 +1,57 @@
+module ApiModel
+  class Response
+    FALL_THROUGH_METHODS = [
+      :class, :nil?, :empty?, :acts_like?, :as_json, :blank?, :duplicable?,
+      :eval_js, :html_safe?, :in?, :presence, :present?, :psych_to_yaml, :to_json,
+      :to_param, :to_query, :to_yaml, :to_yaml_properties, :with_options, :is_a?,
+      :respond_to?, :kind_of?
+    ]
+
+    attr_accessor :http_response, :objects
+
+    def initialize(http_response)
+      @http_response = http_response
+    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
+      end
+
+      self
+    end
+
+    def build(builder, hash)
+      if builder.respond_to? :build
+        builder.build hash
+      else
+        builder.new hash
+      end
+    end
+
+    def json_response_body
+      JSON.parse http_response.body
+    rescue JSON::ParserError
+      Log.info "Could not parse JSON response: #{http_response.body}"
+      return nil
+    end
+
+    # Define common methods which should never be called on this abstract class, and should always be
+    # passed down to the #objects
+    FALL_THROUGH_METHODS.each do |transparent_method|
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def #{transparent_method}(*args, &block)
+          objects.send '#{transparent_method}', *args, &block
+        end
+      RUBY_EVAL
+    end
+
+    def method_missing(method_name, *args, &block)
+      objects.send method_name, *args, &block
+    end
+
+  end
+end

data/spec/lib/api_host_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'support/mock_models/banana'
+require 'support/mock_models/multiple_hosts'
+
+describe ApiModel do
+  describe "api_host" do
+    it "should be possible to set the base api_host" do
+      Banana.api_host = "http://api-model-specs.com"
+      Banana.api_host.should eq "http://api-model-specs.com"
+    end
+
+    describe "with combinations of setting different hosts" do
+      it "should no override each other" do
+        MultipleHostsFoo.api_host.should eq("http://foo.com")
+        MultipleHostsBar.api_host.should eq("http://bar.com")
+        MultipleHostsNone.api_host.should eq("")
+      end
+    end
+  end
+end

data/spec/lib/api_model_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'support/mock_models/blog_post'
+
+describe ApiModel do
+
+  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
+
+end

data/spec/lib/http_request_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'support/mock_models/blog_post'
+
+describe ApiModel::HttpRequest do
+
+  describe "default attributes" do
+    subject { ApiModel::HttpRequest.new }
+
+    it "should default #method to :get" do
+      subject.method.should eq :get
+    end
+
+    it "should default #options to a blank hash" do
+      subject.options.should eq Hash.new
+    end
+  end
+
+  describe "using api_host" do
+    let(:blog_post) do
+      BlogPost.api_host = "http://api-model-specs.com"
+
+      VCR.use_cassette('posts') do
+        BlogPost.get_json "/single_post"
+      end
+    end
+
+    it "should be used with #path to generate a #full_path" do
+      blog_post.http_response.request.url.should eq "http://api-model-specs.com/single_post"
+    end
+  end
+
+  describe "sending a GET request" do
+    let(:request) { ApiModel::HttpRequest.new path: "http://api-model-specs.com/posts", method: :get }
+
+    it "should use typhoeus to send a request" do
+      VCR.use_cassette('posts') do
+        request.run
+      end
+
+      request.api_call.success?.should eq true
+    end
+  end
+end

data/spec/lib/initializer_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'support/mock_models/banana'
+
+describe ApiModel::Initializer do
+
+  let(:banana) { Banana.new color: "yellow", size: "large" }
+
+  it "should set attributes when initializing with a hash" do
+    expect(banana.color).to eq "yellow"
+    expect(banana.size).to eq "large"
+  end
+
+  it "should be easy to update attributes once set" do
+    banana.update_attributes color: "green", size: "small"
+    expect(banana.color).to eq "green"
+    expect(banana.size).to eq "small"
+  end
+
+  it "should not blog up if update_attributes is called with nil" do
+    expect {
+      banana.update_attributes nil
+    }.to_not raise_error
+  end
+
+  it "should run callbacks on initialize" do
+    banana.ripe.should eq true
+  end
+
+  it "should log if an attempt was made to set an attribute which is not defined" do
+    ApiModel::Log.should_receive(:debug).with "Could not set foo on Banana"
+    Banana.new foo: "bar"
+  end
+
+end

data/spec/lib/response_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'support/mock_models/blog_post'
+
+describe ApiModel::Response do
+  
+  let(:valid_response) do
+    VCR.use_cassette('posts') do
+      ApiModel::HttpRequest.new(path: "http://api-model-specs.com/single_post", method: :get).run
+    end
+  end
+
+  describe "parsing the json body" do
+    it "should produce a hash given valid json" do
+      valid_response.json_response_body.should be_a(Hash)
+      valid_response.json_response_body["name"].should eq "foo"
+    end
+
+    it "should catch errors from parsing invalid json" do
+      valid_response.stub_chain(:http_response, :body).and_return "blah"
+      ApiModel::Log.should_receive(:info).with "Could not parse JSON response: blah"
+      
+      expect {
+        valid_response.json_response_body
+      }.to_not raise_error
+    end
+  end
+
+  describe "#build" do
+    it "should use the builder.build method if present" do
+      builder = double
+      builder.should_receive(:build).with something: "foo"
+
+      valid_response.build builder, something: "foo"
+    end
+
+    it "should use builder.new if there's no builder.build method" do
+      builder = double
+      builder.should_receive(:new).with something_else: "hi"
+
+      valid_response.build builder, something_else: "hi"
+    end
+  end
+
+  describe "#build_objects" do
+    let(:single_object) do
+      valid_response.stub(:json_response_body).and_return name: "foo"
+      valid_response.build_objects BlogPost
+    end
+
+    let(:array_of_objects) do
+      valid_response.stub(:json_response_body).and_return [{name: "foo"}, {name: "bar"}]
+      valid_response.build_objects BlogPost
+    end
+
+    it "should build a single object" do
+      single_object.should be_a(BlogPost)
+      single_object.name.should eq "foo"
+    end
+
+    it "should build an array of objects" do
+      array_of_objects[0].should be_a(BlogPost)
+      array_of_objects[0].name.should eq "foo"
+
+      array_of_objects[1].should be_a(BlogPost)
+      array_of_objects[1].name.should eq "bar"
+    end
+
+    it "should include the Typhoeus::Response object" do
+      single_object.http_response.should be_a(Typhoeus::Response)
+    end
+
+    it "should include the #json_response_body" do
+      single_object.json_response_body.should eq name: "foo"
+    end
+  end
+
+  describe "passing core methods down to the built class" do
+
+    ApiModel::Response::FALL_THROUGH_METHODS.each do |fall_trhough_method|
+      it "should pass ##{fall_trhough_method} on the built object class" do
+        allow_message_expectations_on_nil
+        valid_response.objects.should_receive(fall_trhough_method)
+        valid_response.send fall_trhough_method
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'vcr'
+
+require 'api-model'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/fixtures'
+  c.hook_into :webmock # or :fakeweb
+end

data/spec/support/fixtures/posts.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api-model-specs.com/posts
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.1
+      Date:
+      - Thu, 28 Nov 2013 16:02:56 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Content-Length:
+      - '248'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"name\":\"foo\"},{\"name\":\"bar\"}]"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+- request:
+    method: get
+    uri: http://api-model-specs.com/single_post
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.1
+      Date:
+      - Thu, 28 Nov 2013 16:02:56 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Content-Length:
+      - '248'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\"name\":\"foo\"}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+recorded_with: VCR 2.8.0

data/spec/support/mock_models/banana.rb

@@ -0,0 +1,8 @@
+class Banana < ApiModel::Base
+  attr_accessor :color, :size, :ripe
+  after_initialize :set_ripeness
+
+  def set_ripeness
+  	self.ripe = color == "yellow"
+  end
+end

data/spec/support/mock_models/blog_post.rb

@@ -0,0 +1,10 @@
+class BlogPost < ApiModel::Base
+  attr_accessor :name, :title
+
+  class CustomBuilder
+    def build(hash)
+      BlogPost.new hash.merge(title: "FOOBAR")
+    end
+  end
+
+end

data/spec/support/mock_models/multiple_hosts.rb

@@ -0,0 +1,10 @@
+class MultipleHostsFoo < ApiModel::Base
+  self.api_host = "http://foo.com"
+end
+
+class MultipleHostsBar < ApiModel::Base
+  self.api_host = "http://bar.com"
+end
+
+class MultipleHostsNone < ApiModel::Base
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: api-model
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Damien Timewell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+description: A simple way of interacting with rest APIs
+email:
+- mail@damientimewell.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- api-model.gemspec
+- lib/api-model.rb
+- lib/api_model/http_request.rb
+- lib/api_model/initializer.rb
+- lib/api_model/response.rb
+- spec/lib/api_host_spec.rb
+- spec/lib/api_model_spec.rb
+- spec/lib/http_request_spec.rb
+- spec/lib/initializer_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/posts.yml
+- spec/support/mock_models/banana.rb
+- spec/support/mock_models/blog_post.rb
+- spec/support/mock_models/multiple_hosts.rb
+homepage: https://github.com/iZettle/api-model
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A simple way of interacting with rest APIs
+test_files:
+- spec/lib/api_host_spec.rb
+- spec/lib/api_model_spec.rb
+- spec/lib/http_request_spec.rb
+- spec/lib/initializer_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/posts.yml
+- spec/support/mock_models/banana.rb
+- spec/support/mock_models/blog_post.rb
+- spec/support/mock_models/multiple_hosts.rb
+has_rdoc: