flexirest 1.2.0

data/spec/lib/result_iterator_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe Flexirest::ResultIterator do
+  let(:response) { double(status: 200, response_headers: { some: 'header'}) }
+
+  it "should be able to have a status set during creation" do
+    result = Flexirest::ResultIterator.new(response)
+    expect(result._status).to eq(200)
+  end
+
+  it "should be able to have headers set during creation" do
+    result = Flexirest::ResultIterator.new(response)
+    expect(result._headers).to eq({ some: 'header'})
+  end
+
+  it "should be able to have a status set after creation" do
+    result = Flexirest::ResultIterator.new
+    result._status = 200
+    expect(result._status).to eq(200)
+  end
+
+  it "should remember objects given to it" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result.each do |element|
+      expect(element).to eq("a")
+    end
+  end
+
+  it "should implement first" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "z"
+    expect(result.first).to eq("a")
+  end
+
+  it "should implement any?" do
+    result = Flexirest::ResultIterator.new
+    expect(result.any?).to be_falsey
+    result << "a"
+    expect(result.any?).to be_truthy
+  end
+
+  it "should implement items" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "ab"
+    expect(result.items).to eq(["a","ab"])
+  end
+
+  it "should implement last" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "z"
+    expect(result.last).to eq("z")
+  end
+
+  it "should implement size" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "z"
+    expect(result.size).to eq(2)
+  end
+
+  it "should implement index" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "z"
+    expect(result.index("z")).to eq(1)
+  end
+
+  it "should implement empty?" do
+    result = Flexirest::ResultIterator.new
+    expect(result.empty?).to be_truthy
+    result << "a"
+    result << "z"
+    expect(result.empty?).to be_falsey
+  end
+
+  it "should implement reverse" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "z"
+    expect(result.reverse.first).to eq("z")
+    expect(result.reverse.last).to eq("a")
+  end
+
+  it "should implement direct index access" do
+    result = Flexirest::ResultIterator.new
+    result << "a"
+    result << "z"
+    expect(result[0]).to eq("a")
+    expect(result[1]).to eq("z")
+  end
+
+  it "should implement shuffle" do
+    result = Flexirest::ResultIterator.new
+    100.times do |n|
+      result << n
+    end
+    expect(result.shuffle.first == result.shuffle.first && result.shuffle.first == result.shuffle.first).to_not be_truthy
+  end
+
+  it "can parallelise calls to each item" do
+    result = Flexirest::ResultIterator.new
+    result << 3
+    result << 2
+    result << 1
+    delay = 0.05
+    start_time = Time.now
+    response = result.parallelise do |item|
+      sleep(delay * item)
+      item*2
+    end
+    end_time = Time.now
+    expect(end_time-start_time).to be < (6*delay)
+    expect(response).to eq([6,4,2])
+  end
+
+  it "raises an error if you call paginate without WillPaginate installed" do
+    result = Flexirest::ResultIterator.new
+    result << 3
+    expect{result.paginate}.to raise_error
+  end
+
+  it "returns a WillPaginate::Collection if you call paginate with WillPaginate installed" do
+    result = Flexirest::ResultIterator.new
+    result << 3
+
+    module ::WillPaginate
+      class Collection ; end
+    end
+    allow(::WillPaginate).to receive(:per_page).and_return(10)
+    collection = double("WillPaginate::Collection")
+    allow(collection).to receive(:create).with(page: 1, per_page: 2).and_return(collection)
+    allow(::WillPaginate::Collection).to receive(:create).and_return(collection)
+    expect(result.paginate(page: 1, per_page: 2)).to eq(collection)
+    Object.send(:remove_const, :WillPaginate)
+  end
+end

data/spec/lib/validation_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe "Flexirest::Validation" do
+  class SimpleValidationExample < OpenStruct
+    include Flexirest::Validation
+    validates :first_name, presence:true
+    validates :password, length:{within:6..12}
+    validates :post_code, length:{minimum:6, maximum:8}
+    validates :salary, numericality:true, minimum:20_000, maximum:50_000
+  end
+
+  it "should be able to register a validation" do
+    expect(SimpleValidationExample._validations.size).to eq(4)
+  end
+
+  it "should be invalid if a required value isn't present" do
+    a = SimpleValidationExample.new
+    a.first_name = nil
+    a.valid?
+    expect(a._errors[:first_name].size).to eq(1)
+  end
+
+  it "should be valid if a required value is present" do
+    a = SimpleValidationExample.new
+    a.first_name = "John"
+    a.valid?
+    expect(a._errors[:first_name]).to be_empty
+  end
+
+  it "should be invalid if a length within value is outside the range" do
+    a = SimpleValidationExample.new(password:"12345")
+    a.valid?
+    expect(a._errors[:password].size).to eq(1)
+  end
+
+  it "should be valid if a length within value is inside the range" do
+    a = SimpleValidationExample.new(password:"123456")
+    a.valid?
+    expect(a._errors[:password].size).to eq(0)
+  end
+
+  it "should be invalid if a length is below the minimum" do
+    a = SimpleValidationExample.new(post_code:"12345")
+    a.valid?
+    expect(a._errors[:post_code].size).to eq(1)
+  end
+
+  it "should be valid if a length is above or equal to the minimum and below the maximum" do
+    a = SimpleValidationExample.new(post_code:"123456")
+    a.valid?
+    expect(a._errors[:post_code].size).to eq(0)
+  end
+
+  it "should be invalid if a length is above the maximum" do
+    a = SimpleValidationExample.new(post_code:"123456789")
+    a.valid?
+    expect(a._errors[:post_code].size).to eq(1)
+  end
+
+  it "should be able to validate that a field is numeric" do
+    a = SimpleValidationExample.new(salary:"Bob")
+    a.valid?
+    expect(a._errors[:salary].size).to be > 0
+  end
+
+  it "should be able to validate that a numeric field is above or equal to a minimum" do
+    a = SimpleValidationExample.new(salary:10_000)
+    a.valid?
+    expect(a._errors[:salary].size).to be > 0
+  end
+
+  it "should be able to validate that a numeric field is above or equal to a minimum" do
+    a = SimpleValidationExample.new(salary:100_000)
+    a.valid?
+    expect(a._errors[:salary].size).to be > 0
+  end
+
+  it "should be invalid when a block adds an error" do
+    class ValidationExample1 < OpenStruct
+      include Flexirest::Validation
+      validates :first_name do |object, name, value|
+        object._errors[name] << "must be over 4 chars long" if value.length <= 4
+      end
+    end
+    a = ValidationExample1.new(first_name:"John")
+    a.valid?
+    expect(a._errors[:first_name].size).to eq(1)
+  end
+
+  it "should be valid when a block doesn't add an error" do
+    class ValidationExample2 < OpenStruct
+      include Flexirest::Validation
+      validates :first_name do |object, name, value|
+        object._errors[name] << "must be over 4 chars long" if value.length <= 4
+      end
+    end
+    a = ValidationExample2.new(first_name:"Johnny")
+    a.valid?
+    expect(a._errors[:first_name]).to be_empty
+  end
+
+  it "should call valid? before making a request" do
+    class ValidationExample3 < Flexirest::Base
+      whiny_missing true
+      post :create, '/'
+      validates :name, presence:true
+    end
+
+    expect_any_instance_of(ValidationExample3).to receive(:valid?)
+    object = ValidationExample3.new
+    expect { object.create }.to raise_exception(Flexirest::ValidationFailedException)
+  end
+end

data/spec/lib/xml_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+class XmlResponseExample < Flexirest::Base
+  base_url "http://www.example.com/v1/"
+  get :root, "/root", ignore_xml_root: "feed", fake_content_type: "application/xml", fake: %Q{
+    <?xml version="1.0" encoding="utf-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+      <title>Example Feed</title>
+    </feed>
+  }
+  get :atom, "/atom", fake: %Q{
+    <?xml version="1.0" encoding="utf-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+
+      <title>Example Feed</title>
+      <link href="http://example.org/"/>
+      <updated>2003-12-13T18:30:02Z</updated>
+      <author>
+        <name>John Doe</name>
+      </author>
+      <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
+
+      <entry>
+        <title>Atom-Powered Robots Run Amok</title>
+        <link href="http://example.org/2003/12/13/atom03"/>
+        <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
+        <updated>2003-12-13T18:30:02Z</updated>
+        <summary>Some text.</summary>
+      </entry>
+
+      <entry>
+        <title>Something else cool happened</title>
+        <link href="http://example.org/2015/08/11/andyjeffries"/>
+        <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6b</id>
+        <updated>2015-08-11T18:30:02Z</updated>
+        <summary>Some other text.</summary>
+      </entry>
+
+    </feed>}.strip_heredoc, fake_content_type: "application/xml"
+end
+
+describe XmlResponseExample do
+  it "should parse the response without error" do
+    expect {
+      XmlResponseExample.atom
+    }.to_not raise_error
+  end
+
+  it "provides the feed title" do
+    @atom = XmlResponseExample.atom
+    expect(@atom.feed.title).to eq("Example Feed")
+  end
+
+  it "provides the link's href" do
+    @atom = XmlResponseExample.atom
+    expect(@atom.feed.link.href).to eq("http://example.org/")
+  end
+
+  it "each entry item has a title" do
+    @atom = XmlResponseExample.atom
+    expect(@atom.feed.entry.class).to eq(Flexirest::ResultIterator)
+  end
+
+  it "provides a list of entry items" do
+    @atom = XmlResponseExample.atom
+    expect(@atom.feed.entry[0].title).to eq("Atom-Powered Robots Run Amok")
+    expect(@atom.feed.entry[1].title).to eq("Something else cool happened")
+  end
+
+  it "allows ignoring of the XML root node" do
+    @feed = XmlResponseExample.root
+    expect(@feed.title).to eq("Example Feed")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+require 'rspec'
+require 'simplecov'
+require 'flexirest'
+require "ostruct"
+require 'webmock/rspec'
+
+if ENV["JENKINS"]
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+elsif ENV["TRAVIS"]
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+RSpec.configure do |config|
+  config.color = true
+  # config.formatter     = 'documentation'
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.mock_with :rspec do |mocks|
+    # In RSpec 3, `any_instance` implementation blocks will be yielded the receiving
+    # instance as the first block argument to allow the implementation block to use
+    # the state of the receiver.
+    # In RSpec 2.99, to maintain compatibility with RSpec 3 you need to either set
+    # this config option to `false` OR set this to `true` and update your
+    # `any_instance` implementation blocks to account for the first block argument
+    # being the receiving instance.
+    mocks.yield_receiver_to_any_instance_implementation_blocks = true
+  end
+end
+
+class TestCacheStore
+  def initialize
+    @items = {}
+  end
+
+  def read(key)
+    @items[key]
+  end
+
+  def write(key, value, options={})
+    @items[key] = value
+  end
+
+  def fetch(key, &block)
+    read(key) || begin
+      value = block.call
+      write(value)
+      value
+    end
+  end
+end
+
+class FaradayResponseMock < ::Flexirest::FaradayResponseProxy
+  # The FaradayResponseMock is setup to automatically resolve all calls by default.
+  # By setting auto_resolve to false it allows the spec to control when the response
+  # is resolved, which simulates what it is like when inside a Faraday in_parallel block.
+  def initialize(response, auto_resolve=true)
+    super(response)
+    @auto_resolve = auto_resolve
+    @finished = false
+  end
+
+  def on_complete
+    if @auto_resolve
+      @finished = true
+      yield(@response)
+    else
+      @callback = Proc.new
+    end
+  end
+
+  # This is exactly what is called on responses after a Faraday in_parallel block ends.
+  # This method simulates the end of in_parallel block.
+  def finish
+    @finished = true
+    @callback.call(@response)
+  end
+
+  def finished?
+    @finished
+  end
+end

metadata

@@ -0,0 +1,347 @@
+--- !ruby/object:Gem::Specification
+name: flexirest
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Which Ltd
+- Andy Jeffries
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rspec_junit_formatter
+  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: simplecov
+  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: simplecov-rcov
+  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: guard-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: terminal-notifier-guard
+  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: coveralls
+  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: api-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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: multi_json
+  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: crack
+  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: 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: faraday
+  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'
+description: Accessing REST services in an ActiveRecord style
+email:
+- swlicensing@which.co.uk
+- andy@andyjeffries.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/ActiveRestClient Internals.graffle
+- doc/ActiveRestClient Internals.png
+- flexirest.gemspec
+- lib/flexirest.rb
+- lib/flexirest/base.rb
+- lib/flexirest/caching.rb
+- lib/flexirest/configuration.rb
+- lib/flexirest/connection.rb
+- lib/flexirest/connection_manager.rb
+- lib/flexirest/headers_list.rb
+- lib/flexirest/instrumentation.rb
+- lib/flexirest/lazy_association_loader.rb
+- lib/flexirest/lazy_loader.rb
+- lib/flexirest/logger.rb
+- lib/flexirest/mapping.rb
+- lib/flexirest/monkey_patching.rb
+- lib/flexirest/proxy_base.rb
+- lib/flexirest/recording.rb
+- lib/flexirest/request.rb
+- lib/flexirest/request_delegator.rb
+- lib/flexirest/request_filtering.rb
+- lib/flexirest/result_iterator.rb
+- lib/flexirest/validation.rb
+- lib/flexirest/version.rb
+- spec/lib/base_spec.rb
+- spec/lib/caching_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/connection_manager_spec.rb
+- spec/lib/connection_spec.rb
+- spec/lib/headers_list_spec.rb
+- spec/lib/instrumentation_spec.rb
+- spec/lib/lazy_association_loader_spec.rb
+- spec/lib/lazy_loader_spec.rb
+- spec/lib/logger_spec.rb
+- spec/lib/mapping_spec.rb
+- spec/lib/proxy_spec.rb
+- spec/lib/recording_spec.rb
+- spec/lib/request_filtering_spec.rb
+- spec/lib/request_spec.rb
+- spec/lib/result_iterator_spec.rb
+- spec/lib/validation_spec.rb
+- spec/lib/xml_spec.rb
+- spec/spec_helper.rb
+homepage: http://whichdigital.github.io/
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: This gem is for accessing REST services in an ActiveRecord style.  ActiveResource
+  already exists for this, but it doesn't work where the resource naming doesn't follow
+  Rails conventions, it doesn't have in-built caching and it's not as flexible in
+  general.
+test_files:
+- spec/lib/base_spec.rb
+- spec/lib/caching_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/connection_manager_spec.rb
+- spec/lib/connection_spec.rb
+- spec/lib/headers_list_spec.rb
+- spec/lib/instrumentation_spec.rb
+- spec/lib/lazy_association_loader_spec.rb
+- spec/lib/lazy_loader_spec.rb
+- spec/lib/logger_spec.rb
+- spec/lib/mapping_spec.rb
+- spec/lib/proxy_spec.rb
+- spec/lib/recording_spec.rb
+- spec/lib/request_filtering_spec.rb
+- spec/lib/request_spec.rb
+- spec/lib/result_iterator_spec.rb
+- spec/lib/validation_spec.rb
+- spec/lib/xml_spec.rb
+- spec/spec_helper.rb
+has_rdoc: