siren_client 0.1

data/spec/support/test_server.rb

@@ -0,0 +1,17 @@
+require 'sinatra'
+require 'json'
+
+class TestServer < Sinatra::Base
+  @@url = 'http://localhost:9292'
+
+  use Rack::Auth::Basic, "SirenClient Test API" do |username, password|
+    username == 'admin' and password == '1234'
+  end
+
+  before do
+    content_type 'application/vnd.siren+json'
+  end
+end
+
+# Require all the endpoint files that build the api.
+Dir[__dir__ + "/endpoints/*.rb"].each {|file| require file }

data/spec/unit/action_spec.rb

@@ -0,0 +1,86 @@
+require 'helper/spec_helper'
+
+describe SirenClient::Action do
+  let (:action_data) { {"name"=>"search","method"=>"GET","href"=>"http://example.com/products","fields"=>[{"name"=>"search","type"=>"text"}]} }
+
+  describe '.new(data)' do
+      it 'raise an error if wrong type is provided' do
+        expect { SirenClient::Action.new([]) }.to raise_error(ArgumentError)
+      end
+      it 'can be instanciated with a hash' do
+        expect(SirenClient::Action.new(action_data)).to be_a SirenClient::Action
+      end
+  end
+
+  let (:action) { 
+    SirenClient::Action.new(action_data, { 
+      headers: { "Accept" => "application/json" } 
+    })
+  }
+  describe '.config' do
+    it 'is a hash' do
+      expect(action.config).to be_a Hash
+    end
+    it 'can access a property of the config' do
+      expect(action.config[:headers]['Accept']).to eq('application/json')
+    end
+  end
+  describe '.payload' do
+    it 'is a hash' do
+      expect(action.payload).to be_a Hash
+    end
+  end
+  describe '.name' do
+    it 'is a string' do
+      expect(action.name).to be_a String
+    end
+  end
+  describe '.classes' do
+    it 'is an array' do
+      expect(action.classes).to be_a Array
+    end
+  end
+  describe '.method' do
+    it 'is a string' do
+      expect(action.method).to be_a String
+    end
+    it 'defaults to GET' do
+      expect(SirenClient::Action.new({ }).method).to eq('get')
+    end
+  end
+  describe '.href' do
+    it 'is a string' do
+      expect(action.href).to be_a String
+    end
+  end
+  describe '.title' do
+    it 'is a string' do
+      expect(action.title).to be_a String
+    end
+  end
+  describe '.type' do
+    it 'is a string' do
+      expect(action.type).to be_a String
+    end
+    it 'defaults to \'application/x-www-form-urlencoded\'' do
+      expect(action.type).to eq('application/x-www-form-urlencoded')
+    end
+  end
+  describe '.fields' do
+    it 'is an array' do
+      expect(action.fields).to be_a Array
+    end
+    it 'is an array of SirenClient::Field\'s' do
+      action.fields.each do |field|
+        expect(field).to be_a SirenClient::Field
+      end
+    end
+  end
+  describe '.where(params)' do
+    it 'executes the action without any parameters' do
+      # I'm expecting an error here, all I want to see is that the url it being traversed.
+      expect { action.where }.to raise_error
+    end
+    # The rest will be tested in the live specs.
+  end
+end

data/spec/unit/base_spec.rb

@@ -0,0 +1,52 @@
+require 'helper/spec_helper'
+
+describe SirenClient do
+  let (:url_error_msg)     { 'You must supply a valid url to SirenClient.get' }
+  let (:invalid_param_msg) { 'You must supply either a string or hash to SirenClient.get' }
+
+  describe '.get(config)' do
+    it "raise an error if no options are provided" do
+      expect { SirenClient.get }.to raise_error(ArgumentError)
+    end
+    it "raise an error if an improper param is provided" do
+      expect { SirenClient.get([1, 2, 3]) }.to raise_error(ArgumentError, invalid_param_msg) 
+      expect { SirenClient.get(nil) }.to raise_error(ArgumentError, invalid_param_msg)
+    end
+    it "raise an error if no url is provided" do
+      expect { SirenClient.get(url: nil) }.to raise_error(ArgumentError, url_error_msg)
+    end
+    it "raise an error if an invalid url is provided" do
+      expect { SirenClient.get('error on me') }.to raise_error(SirenClient::InvalidURIError)
+    end
+    it "raise an error if the url does not return json" do
+      expect { SirenClient.get('http://google.com') }.to raise_error(SirenClient::InvalidResponseError)
+    end
+  end
+  describe '.logger(before)' do
+    it 'is a standard ruby logger instance' do
+      expect(SirenClient.logger).to be_a Logger
+    end
+  end
+  describe '.logger=' do
+    it 'raise an error if it does not respect the logger interface' do
+      expect { SirenClient.logger = "error" }.to raise_error
+    end
+    it 'accepts an instance that respects the logger interface' do
+      SirenClient.logger = Logger.new(STDOUT)
+      SirenClient.logger.level = Logger::WARN
+      expect(SirenClient.logger).to be_a Logger
+    end
+  end
+  describe '.logger(after)' do
+    it 'responds to .info(str)' do
+      expect(SirenClient.logger.respond_to?(:info)).to eq(true)
+    end
+    it 'responds to .warn(str)' do
+      expect(SirenClient.logger.respond_to?(:warn)).to eq(true)
+    end
+    it 'responds to .error(str)' do
+      expect(SirenClient.logger.respond_to?(:error)).to eq(true)
+    end
+  end
+  # Remainder will be tested in live spec
+end

data/spec/unit/entity_spec.rb

@@ -0,0 +1,179 @@
+require 'helper/spec_helper'
+
+describe SirenClient::Entity do
+  
+  describe '.new(data)' do
+    it 'raise an error if no param is provided' do
+      expect { SirenClient::Entity.new }.to raise_error(ArgumentError)
+    end
+    it 'raise an error if an invalid type is provided' do
+      expect { SirenClient::Entity.new([]) }.to raise_error(ArgumentError)
+    end
+    it 'raise an error if an invalid url is provided' do
+      expect { SirenClient::Entity.new('error me') }.to raise_error(SirenClient::InvalidURIError)
+    end
+    it 'raise an error if the url does not return json' do
+      expect { SirenClient::Entity.new('http://www.google.com') }.to raise_error(SirenClient::InvalidResponseError)
+    end
+    # it 'can be instanciated with a proper url' do 
+    #   expect(SirenClient::Entity.new(valid_url)).to be_a SirenClient::Entity
+    # end
+    it 'can be instanciated with a hash of data' do 
+      expect(SirenClient::Entity.new(siren_body)).to be_a SirenClient::Entity
+    end
+  end
+
+  let (:entity) { 
+    SirenClient::Entity.new(siren_body, { 
+      headers: { "Accept" => "application/json" } 
+    })
+  }
+  describe '.config' do
+    it 'is a hash' do
+      expect(entity.config).to be_a Hash
+    end
+    it 'can access property in the config' do
+      expect(entity.config[:headers]['Accept']).to eq('application/json')
+    end
+  end
+  describe '.payload' do
+    it 'is a hash' do
+      expect(entity.payload).to be_a Hash
+    end
+  end
+  describe '.classes' do
+    it 'is an array' do
+      expect(entity.classes).to be_a Array
+    end
+  end
+  describe '.properties' do
+    it 'is a hash' do
+      expect(entity.properties).to be_a Hash
+    end
+    it 'can access a property' do
+      expect(entity.properties['page']).to eq(1)
+    end
+    it 'can access a property directly on the entity' do
+      expect(entity.page).to eq(1)
+    end
+  end
+  describe '.entities' do
+    it 'is an array' do
+      expect(entity.entities).to be_a Array
+    end
+    it 'is an array of SirenClient::Entity\'s' do
+      entity.entities.each do |ent|
+        expect(ent).to be_a SirenClient::Entity
+      end
+    end
+  end
+  describe '.rels' do
+    it 'is an array' do
+      expect(entity.rels).to be_a Array
+    end
+  end
+  describe '.links' do
+    it 'is a hash' do
+      expect(entity.links).to be_a Hash
+    end
+    it 'is a hash of { key => SirenClient::Link }\'s' do
+      expect {
+        entity.links.each do |key, link|
+          expect(key).to be_a String
+          expect(link).to be_a SirenClient::Link
+        end
+      }.to_not raise_error
+    end
+    it 'can access a link' do
+      expect(entity.links['self']).to be_a SirenClient::Link
+    end
+  end
+  describe '.actions' do
+    it 'is a hash' do
+      expect(entity.actions).to be_a Hash
+    end
+    it 'is a hash of { key => SirenClient::Action }\'s' do
+      expect {
+        entity.actions.each do |name, action|
+          expect(name).to be_a String
+          expect(action).to be_a SirenClient::Action
+        end
+      }.to_not raise_error
+    end
+    it 'can access an action' do
+      expect(entity.actions['filter_concepts']).to be_a SirenClient::Action
+    end
+  end
+  # This will be empty unless it's an entity sub-link.
+  describe '.href' do
+    it 'is a string' do
+      expect(entity.href).to be_a String
+    end
+    it 'should be empty' do
+      expect(entity.href).to eq('')
+    end
+  end
+  # Similar to SirenClient::Link.go this function will create a 
+  # new entity from the .href method. For entity sub-links only.
+  describe '.go' do
+    let (:graph) { entity[0] } 
+    it 'return nil if it\'s NOT an entity sub-link' do
+      expect(entity.go).to eq(nil)
+    end
+    it 'initiate a request if it IS an entity sub-link' do
+      expect { graph.entities[0].go }.to raise_error
+    end
+  end
+  describe '.invalidkey' do
+    it 'will throw a NoMethodError' do
+      expect { entity.thisdoesntexist }.to raise_error(NoMethodError)
+    end
+  end
+  describe '.validkey' do
+    let (:graph) { entity[0] } 
+    it 'can access an entity sub-link within the entity' do
+      expect { graph.messages }.to raise_error
+    end
+    it 'can access a link directly on the entity' do
+      expect { entity.next }.to raise_error
+    end
+    it 'can access an action directly on the entity' do
+      expect(entity.filter_concepts).to be_a SirenClient::Action
+    end
+  end
+  describe '.title' do
+    it 'is a string' do
+      expect(entity.title).to be_a String
+    end
+  end
+  describe '.type' do
+    it 'is a string' do
+      expect(entity.type).to be_a String
+    end
+  end
+  describe '.length' do
+    it 'can return the size of @entities' do
+      expect(entity.length).to eq(1)
+    end
+  end
+  describe '[x]' do
+    it 'can get the first element' do
+      expect(entity[0]).to be_a SirenClient::Entity
+    end
+    it 'can get the last element' do
+      expect(entity[-1]).to be_a SirenClient::Entity
+    end
+    it 'causes entity sub-links to be traversed' do
+      expect(entity[0]).to be_a SirenClient::Entity
+    end
+  end
+  describe '.each' do
+    it 'can iterate over all the entities' do
+      expect {
+        entity.each do |ent|
+          expect(ent).to be_a SirenClient::Entity
+        end
+      }.to_not raise_error
+    end
+  end
+end

data/spec/unit/field_spec.rb

@@ -0,0 +1,44 @@
+require 'helper/spec_helper'
+
+describe SirenClient::Field do
+  let (:field_data) { {"name"=>"search","type"=>"text"} }
+
+  describe '.new(data)' do
+      it 'raise an error if wrong type is provided' do
+        expect { SirenClient::Field.new([]) }.to raise_error(ArgumentError)
+      end
+      it 'can be instanciated with a hash' do
+        expect(SirenClient::Field.new(field_data)).to be_a SirenClient::Field
+      end
+  end
+
+  let (:field) { SirenClient::Field.new(field_data) }
+  describe '.payload' do
+    it 'is a hash' do
+      expect(field.payload).to be_a Hash
+    end
+  end
+  describe '.name' do
+    it 'is a string' do
+      expect(field.name).to be_a String
+    end
+  end
+  describe '.type' do
+    it 'is a string' do
+      expect(field.type).to be_a String
+    end
+    it 'default to "text"' do
+      expect(SirenClient::Field.new({ }).type).to eq('text')
+    end
+  end
+  describe '.value' do
+    it 'is a string' do
+      expect(field.value).to be_a String
+    end
+  end
+  describe '.title' do
+    it 'is a string' do
+      expect(field.title).to be_a String
+    end
+  end
+end

data/spec/unit/link_spec.rb

@@ -0,0 +1,47 @@
+require 'helper/spec_helper'
+
+describe SirenClient::Link do
+  let (:link_data) { {"rel"=>["self"],"href"=>"http://example.com/products/03283378000P"} }
+
+  describe '.new(data)' do
+      it 'raise an error if wrong type is provided' do
+        expect { SirenClient::Link.new([]) }.to raise_error(ArgumentError)
+      end
+      it 'can be instanciated with a hash' do
+        expect(SirenClient::Link.new(link_data)).to be_a SirenClient::Link
+      end
+  end
+
+  let (:link) { SirenClient::Link.new(link_data) }
+  describe '.go' do
+    it 'follows the link\'s href' do
+      # We just need to know that the link will make the request.
+      expect { link.go }.to raise_error(SirenClient::InvalidResponseError)
+    end
+  end
+  describe '.payload' do
+    it 'is a hash' do
+      expect(link.payload).to be_a Hash
+    end
+  end
+  describe '.rels' do
+    it 'is an array' do
+      expect(link.rels).to be_a Array
+    end
+  end
+  describe '.href' do
+    it 'is a string' do
+      expect(link.href).to be_a String
+    end
+  end
+  describe '.title' do
+    it 'is a string' do
+      expect(link.title).to be_a String
+    end
+  end
+  describe '.type' do
+    it 'is a string' do
+      expect(link.type).to be_a String
+    end
+  end
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: siren_client
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Chason Choate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: 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: sinatra
+  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: sinatra-simple-auth
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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
+  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'
+description: SirenClient provides an ActiveRecord-like syntax to traverse Siren APIs.
+email:
+- cha55son@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/siren_cli
+- lib/siren_cli.rb
+- lib/siren_cli/shell.rb
+- lib/siren_cli/version.rb
+- lib/siren_client.rb
+- lib/siren_client/action.rb
+- lib/siren_client/base.rb
+- lib/siren_client/entity.rb
+- lib/siren_client/exceptions.rb
+- lib/siren_client/field.rb
+- lib/siren_client/link.rb
+- lib/siren_client/version.rb
+- siren_client.gemspec
+- spec/helper/live_spec_helper.rb
+- spec/helper/spec_helper.rb
+- spec/live/traverse_spec.rb
+- spec/support/endpoints/concepts.rb
+- spec/support/endpoints/root.rb
+- spec/support/test_server.rb
+- spec/unit/action_spec.rb
+- spec/unit/base_spec.rb
+- spec/unit/entity_spec.rb
+- spec/unit/field_spec.rb
+- spec/unit/link_spec.rb
+homepage: https://github.com/cha55son/siren_client
+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.5
+signing_key: 
+specification_version: 4
+summary: A client to traverse Siren APIs https://github.com/kevinswiber/siren
+test_files:
+- spec/helper/live_spec_helper.rb
+- spec/helper/spec_helper.rb
+- spec/live/traverse_spec.rb
+- spec/support/endpoints/concepts.rb
+- spec/support/endpoints/root.rb
+- spec/support/test_server.rb
+- spec/unit/action_spec.rb
+- spec/unit/base_spec.rb
+- spec/unit/entity_spec.rb
+- spec/unit/field_spec.rb
+- spec/unit/link_spec.rb