api-model 0.0.2 → 0.0.3

data/spec/support/fixtures/errors.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api-model-specs.com/needs_auth
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 401
+      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: "{}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+- request:
+    method: get
+    uri: http://api-model-specs.com/not_found
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 404
+      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: "{}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+recorded_with: VCR 2.8.0

data/spec/support/fixtures/posts.yml

@@ -27,6 +27,33 @@ http_interactions:
     http_version:
   recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
 
+- request:
+    method: post
+    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
@@ -54,4 +81,33 @@ http_interactions:
     http_version:
   recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
 
+- request:
+    method: post
+    uri: http://api-model-specs.com/create_with_json
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+    body:
+      string: "{\"name\":\"foobarbaz\"}"
+  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\":\"foobarbaz\"}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
 recorded_with: VCR 2.8.0

data/spec/support/fixtures/users.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api-model-specs.com/users
+    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: "{\"users\":[{\"name\":\"foo\"}, {\"name\":\"bar\"}, {\"name\":\"baz\"}]}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+- request:
+    method: get
+    uri: http://api-model-specs.com/search
+    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: "{\"search\":{\"results\":{\"users\":[{\"name\":\"foo\"}, {\"name\":\"bar\"}, {\"name\":\"baz\"}]}}}"
+    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

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

data/spec/support/mock_models/blog_post.rb

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

data/spec/support/mock_models/car.rb

@@ -0,0 +1,11 @@
+class Car < ApiModel::Base
+
+  property :number_of_doors, from: :numberOfDoors
+  property :top_speed, transform_with: lambda { |speed| speed * 10 }
+  property :name, default: "Ferrari"
+
+  def is_fast?
+    top_speed > 300
+  end
+
+end

data/spec/support/mock_models/multiple_hosts.rb

@@ -1,9 +1,13 @@
 class MultipleHostsFoo < ApiModel::Base
-  self.api_host = "http://foo.com"
+  api_config do |config|
+    config.host = "http://foo.com"
+  end
 end
 
 class MultipleHostsBar < ApiModel::Base
-  self.api_host = "http://bar.com"
+  api_config do |config|
+    config.host = "http://bar.com"
+  end
 end
 
 class MultipleHostsNone < ApiModel::Base

data/spec/support/mock_models/user.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-model
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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
@@ -117,24 +131,32 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
 - api-model.gemspec
 - lib/api-model.rb
+- lib/api_model/configuration.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
+- lib/api_model/rest_methods.rb
+- spec/api-model/api_model_spec.rb
+- spec/api-model/configuration_spec.rb
+- spec/api-model/http_request_spec.rb
+- spec/api-model/initializer_spec.rb
+- spec/api-model/response_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/cars.yml
+- spec/support/fixtures/errors.yml
 - spec/support/fixtures/posts.yml
+- spec/support/fixtures/users.yml
 - spec/support/mock_models/banana.rb
 - spec/support/mock_models/blog_post.rb
+- spec/support/mock_models/car.rb
 - spec/support/mock_models/multiple_hosts.rb
+- spec/support/mock_models/user.rb
 homepage: https://github.com/iZettle/api-model
 licenses: []
 metadata: {}
@@ -159,14 +181,19 @@ 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/api-model/api_model_spec.rb
+- spec/api-model/configuration_spec.rb
+- spec/api-model/http_request_spec.rb
+- spec/api-model/initializer_spec.rb
+- spec/api-model/response_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/cars.yml
+- spec/support/fixtures/errors.yml
 - spec/support/fixtures/posts.yml
+- spec/support/fixtures/users.yml
 - spec/support/mock_models/banana.rb
 - spec/support/mock_models/blog_post.rb
+- spec/support/mock_models/car.rb
 - spec/support/mock_models/multiple_hosts.rb
+- spec/support/mock_models/user.rb
 has_rdoc: 

data/spec/lib/api_host_spec.rb

@@ -1,20 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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/response_spec.rb

@@ -1,89 +0,0 @@
-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