siren_client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f38d3c4581d5764d0798e4c4d3908f7404ca7cdb
-  data.tar.gz: 3e71628070a1391ef839335602ef778b1d1d7d94
+  metadata.gz: 4925d2e19eecb6f0cf7cc864099089e0b6f18fa3
+  data.tar.gz: f277ababef5cee15f59c437dd6c20e1b84873aa7
 SHA512:
-  metadata.gz: 7edd967f314c6d036d7cfdef8889fd9953b1e0b19523343d71d0e5f1586d7f9438f44e01051aabb4e53e4d5489e6d01aca5f55196494bf89fdb4ecf5897065ec
-  data.tar.gz: 043795907a4f6166549f42f9776447a1566d8e7f47f1f7995e47826f500e467eee0e904fd50c7a4209241b2022bcbe353c0436cc78c5e00d658dc35c04d3d579
+  metadata.gz: 4532ad1cdb6fbab5ae42a02127ebba0ec2610268dde0bfbe62d0c07850704c35f93a45f79018ba81de54a623802665c7b0a49b7c94cef3dbd66637ebddceccc9
+  data.tar.gz: d71716ea6cad51b955cad7ec2b8c9467fa2d0a81f51056d49b9b0431314a5958895187ca26022b11fa41737f8d6f843569c23a0490afd736eb4b0564b50e90a5

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

data/.travis.yml

@@ -1,3 +1,5 @@
+before_install:
+  - 'if [[ "$TRAVIS_RUBY_VERSION" =~ "jruby" ]]; then rvm get head && rvm reload && rvm use --install $TRAVIS_RUBY_VERSION; fi'
 language: ruby
 rvm:
   - "1.9.3"
@@ -5,4 +7,5 @@ rvm:
   - "2.1.0"
   - "2.2.0"
   - jruby-19mode
+  - jruby-9.0.5.0
 script: bundle exec rspec

data/README.md

@@ -1,4 +1,4 @@
-# SirenClient [![Build Status](https://travis-ci.org/cha55son/siren_client.svg)](https://travis-ci.org/cha55son/siren_client)
+# SirenClient [![Build Status](https://travis-ci.org/cha55son/siren_client.svg)](https://travis-ci.org/cha55son/siren_client) [![Coverage Status](https://coveralls.io/repos/cha55son/siren_client/badge.svg)](https://coveralls.io/r/cha55son/siren_client)
 
 A simple client for traversing Siren APIs. Not sure what Siren is? View the spec here: https://github.com/kevinswiber/siren.
 
@@ -13,8 +13,9 @@ require 'siren_client'
 root = SirenClient.get('http://siren-api.example.com')
 
 # Advanced usage
-root = SirenClient.get('http://siren-api.example.com', {
-  headers: { "Accept": "application/json", ... },
+root = SirenClient.get({
+  url: 'http://siren-api.example.com',
+  headers: { "Accept" => "application/json", ... },
   basic_auth: { username: 'person', password: '1234' },
   timeout: 5,
   ... # Refer to https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L45

data/bin/siren_cli

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'byebug' if RUBY_VERSION > '2'
+require 'byebug' if RUBY_VERSION > '2' && RUBY_PLATFORM != "java"
 require 'siren_cli'
 
 SirenCLI::Shell.new

data/lib/siren_client/entity.rb

@@ -2,12 +2,12 @@ module SirenClient
   class Entity
     include Enumerable
     attr_accessor :href
-    attr_reader :payload, :classes, :properties, :entities, :rels, 
+    attr_reader :payload, :classes, :properties, :entities, :rels,
                 :links, :actions, :title, :type, :config
 
 
     def initialize(data, config={})
-      @config = { format: :json }.merge config 
+      @config = { format: :json }.merge config
       if data.class == String
         unless data.class == String && data.length > 0
             raise InvalidURIError, 'An invalid url was passed to SirenClient::Entity.new.'
@@ -42,8 +42,8 @@ module SirenClient
       return false unless criteria
       if criteria.is_a? String
         return entities.select do |ent|
-          true if ent.classes.include?(criteria) || 
-                  ent.rels.include?(criteria) || 
+          true if ent.classes.include?(criteria) ||
+                  ent.rels.include?(criteria) ||
                   ent.href == criteria
         end
       elsif criteria.is_a? Regexp
@@ -60,7 +60,7 @@ module SirenClient
       return if self.href.empty?
       self.class.new(self.href, @config)
     end
-    
+
     def method_missing(method, *args)
       method_str = method.to_s
       return @entities.length if method_str == 'length'
@@ -68,9 +68,9 @@ module SirenClient
       @properties.each do |key, prop|
         return prop if method_str == key
       end
-      # Does it match an entity sub-link's class? 
+      # Does it match an entity sub-link's class?
       @entities.each do |ent|
-        return ent.go if ent.href && 
+        return ent.go if ent.href &&
                          (ent.classes.map { |c| c.underscore }).include?(method_str.underscore)
       end
       # Does it match a link, if so traverse it and return the entity.
@@ -81,7 +81,7 @@ module SirenClient
       @actions.each do |key, action|
         return action if method_str == key.underscore
       end
-      raise NoMethodError, 'The method does not match a property, action, or link on SirenClient::Entity.'
+      raise NoMethodError, "The method \"#{method_str}\" does not match a property, action, or link on SirenClient::Entity."
     end
 
     private

data/lib/siren_client/version.rb

@@ -1,3 +1,3 @@
 module SirenClient
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/siren_client.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sinatra"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "byebug" if RUBY_VERSION > "2"
+  spec.add_development_dependency "byebug" if RUBY_VERSION > "2" && RUBY_PLATFORM != "java"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "coveralls"
 end

data/spec/helper/spec_helper.rb

@@ -1,5 +1,7 @@
-require 'byebug' if RUBY_VERSION > '2'
+require 'byebug' if RUBY_VERSION > '2' && RUBY_PLATFORM != "java"
 require 'siren_client'
+require 'coveralls'
+Coveralls.wear!
 
 RSpec.configure do |config|
   # Ensure we only use `expect` and not `should`.
@@ -26,24 +28,24 @@ def siren_body
           {
             'class' => ['messages', 'collection'],
             'rel' => ['/rels/messages'],
-            'href' => '/graphs/test1/messages'
+            'href' => 'http://localhost/graphs/test1/messages'
           },
           {
             'class' => ['concepts', 'collection'],
             'rel' => ['/rels/concepts'],
-            'href' => '/graphs/test2/concepts'
+            'href' => 'http://localhost/graphs/test2/concepts'
           },
           {
             # Just to test the underscore transformation
             'class' => ['user-preferences', 'collection'],
             'rel' => ['/rels/user-preferences'],
-            'href' => '/graphs/user/preferences'
+            'href' => 'http://localhost/graphs/user/preferences'
           }
         ],
         'links' => [
           {
             'rel' => ['self'],
-            'href' => '/graphs/test1'
+            'href' => 'http://localhost/graphs/test1'
           }
         ]
       }
@@ -52,7 +54,7 @@ def siren_body
       {
         'name' => 'filter_concepts',
         'method' => 'GET',
-        'href' => '/graphs/test1/concepts',
+        'href' => 'http://localhost/graphs/test1/concepts',
         'title' => 'Get an optionally filtered list of Concepts',
         'type' => 'application/x-www-form-urlencoded',
         'fields' => [
@@ -79,7 +81,7 @@ def siren_body
       {
         'name' => 'filter-messages',
         'method' => 'GET',
-        'href' => '/graphs/test1/messages',
+        'href' => 'http://localhost/graphs/test1/messages',
         'title' => 'Get an optionally filtered list of Messages',
         'type' => 'application/x-www-form-urlencoded',
         'fields' => [
@@ -107,15 +109,15 @@ def siren_body
     'links' => [
       {
         'rel' => ['self'],
-        'href' => '/graphs?limit=1&page=1&order_by=name'
+        'href' => 'http://localhost/graphs?limit=1&page=1&order_by=name'
       },
       {
         'rel' => ['prev-page'],
-        'href' => '/graphs?limit=1&page=0&order_by=name'
+        'href' => 'http://localhost/graphs?limit=1&page=0&order_by=name'
       },
       {
         'rel' => ['next'],
-        'href' => '/graphs?limit=1&page=2&order_by=name'
+        'href' => 'http://localhost/graphs?limit=1&page=2&order_by=name'
       }
     ]
   }

data/spec/unit/action_spec.rb

@@ -83,7 +83,7 @@ describe SirenClient::Action do
   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
+      expect { action.where }.to raise_error SirenClient::InvalidResponseError
     end
     # The rest will be tested in the live specs.
   end

data/spec/unit/base_spec.rb

@@ -29,7 +29,7 @@ describe SirenClient do
   end
   describe '.logger=' do
     it 'raise an error if it does not respect the logger interface' do
-      expect { SirenClient.logger = "error" }.to raise_error
+      expect { SirenClient.logger = "error" }.to raise_error SirenClient::InvalidLogger
     end
     it 'accepts an instance that respects the logger interface' do
       SirenClient.logger = Logger.new(STDOUT)

data/spec/unit/entity_spec.rb

@@ -1,7 +1,7 @@
 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)
@@ -15,17 +15,14 @@ describe SirenClient::Entity do
     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 
+    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" } 
+  let (:entity) {
+    SirenClient::Entity.new(siren_body, {
+      headers: { "Accept" => "application/json" }
     })
   }
   describe '.config' do
@@ -117,29 +114,36 @@ describe SirenClient::Entity do
         expect(/query=test/).to match(entity.href)
     end
   end
-  # Similar to SirenClient::Link.go this function will create a 
+  # 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] } 
+    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
+      expect { graph.entities[0].go }.to raise_error Errno::ECONNREFUSED
     end
   end
   describe '.invalidkey' do
     it 'will throw a NoMethodError' do
       expect { entity.thisdoesntexist }.to raise_error(NoMethodError)
     end
+    it 'prints .invalidkey used to NoMethodError message' do
+      begin
+        entity.thisdoesntexist
+      rescue NoMethodError => e
+        expect( e.to_s ).to match(/thisdoesntexist/)
+      end
+    end
   end
   describe '.validkey' do
-    let (:graph) { entity[0] } 
+    let (:graph) { entity[0] }
     it 'can access an entity sub-link within the entity' do
-      expect { graph.messages }.to raise_error
+      expect { graph.messages }.to raise_error Errno::ECONNREFUSED
     end
     it 'can access a link directly on the entity' do
-      expect { entity.next }.to raise_error
+      expect { entity.next }.to raise_error Errno::ECONNREFUSED
     end
     it 'can access an action directly on the entity' do
       expect(entity.filter_concepts).to be_a SirenClient::Action
@@ -171,7 +175,7 @@ describe SirenClient::Entity do
       expect(entity[0]).to be_a SirenClient::Entity
     end
   end
-  let (:graph) { entity[0] } 
+  let (:graph) { entity[0] }
   describe '.search("messages")' do
     it 'returns an Array' do
       expect(graph.search('messages')).to be_a Array
@@ -217,14 +221,14 @@ describe SirenClient::Entity do
   describe 'underscore support' do
     it 'can access entity sub-links' do
       # Since this will trigger the sub-link. We expect an error
-      expect { graph.user_preferences }.to raise_error
+      expect { graph.user_preferences }.to raise_error Errno::ECONNREFUSED
     end
     it 'can access actions' do
       expect(entity.filter_messages).to be_a SirenClient::Action
     end
     it 'can access links' do
       # Since this will trigger the link. We expect an error
-      expect { entity.prev_page }.to raise_error
+      expect { entity.prev_page }.to raise_error Errno::ECONNREFUSED
     end
   end
   # Entities enumerable support
@@ -239,7 +243,7 @@ describe SirenClient::Entity do
       end
     end
     # Useful enumerable methods
-    describe '.all?' do 
+    describe '.all?' do
       it 'matches .entities.all?' do
         expect(
           graph.all? do |ent|
@@ -283,19 +287,6 @@ describe SirenClient::Entity do
         expect(graph.first).to eq(graph.entities.first)
       end
     end
-    describe '.grep' do
-      it "matches .entities.grep" do
-        expect(
-          graph.grep(/test1/) do |ent|
-            ent.href
-          end
-        ).to eq(
-          graph.entities.grep(/test1/) do |ent|
-            ent.href
-          end
-        )
-      end
-    end
     describe '.map' do
       it 'matches .entities.map' do
         expect(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siren_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Chason Choate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !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'
 description: SirenClient provides an ActiveRecord-like syntax to traverse Siren APIs.
 email:
 - cha55son@gmail.com
@@ -209,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A client to traverse Siren APIs https://github.com/kevinswiber/siren