siren_client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2235dbb7d6503b6712f4f2db4c6830fd56bcac2f
-  data.tar.gz: b48315c74552103bacb992ec1d47ad75dcdb2eb5
+  metadata.gz: f38d3c4581d5764d0798e4c4d3908f7404ca7cdb
+  data.tar.gz: 3e71628070a1391ef839335602ef778b1d1d7d94
 SHA512:
-  metadata.gz: 544030c9e76a6cb6ac88c920c6e651b116838ec62d2ef08856fee5883d6fbffca740a2c27c95261f914eb2364c1fbef664332890b50e61ea8fbb6dad80b3f6f8
-  data.tar.gz: 74d4ab57514bfada4a2b8c7b02978588abfcb0edbdf5bd2cd918180f44b767fe7f9cd03d4bebc4d6c20af25afd05e2c5379f14a711c83ab4a39a755c47773e4e
+  metadata.gz: 7edd967f314c6d036d7cfdef8889fd9953b1e0b19523343d71d0e5f1586d7f9438f44e01051aabb4e53e4d5489e6d01aca5f55196494bf89fdb4ecf5897065ec
+  data.tar.gz: 043795907a4f6166549f42f9776447a1566d8e7f47f1f7995e47826f500e467eee0e904fd50c7a4209241b2022bcbe353c0436cc78c5e00d658dc35c04d3d579

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "2.2.0"
+  - jruby-19mode
+script: bundle exec rspec

data/README.md

@@ -1,4 +1,4 @@
-# SirenClient
+# SirenClient [![Build Status](https://travis-ci.org/cha55son/siren_client.svg)](https://travis-ci.org/cha55son/siren_client)
 
 A simple client for traversing Siren APIs. Not sure what Siren is? View the spec here: https://github.com/kevinswiber/siren.
 
@@ -46,6 +46,18 @@ root.entities[x] # This is an array
 root.each do |entity|
   # do something
 end
+# With full enumerable support entities work similarly to arrays
+root.map { |entity| ... }
+root.select { |entity| ... }
+root.find { |entity| ... }
+# You can view all the enumerable methods here: http://ruby-doc.org/core-2.0.0/Enumerable.html
+```
+
+Entities also provide the method `.search` for searching across sub-entities' classes, rels, and hrefs (sub-links only).
+
+```ruby
+root.search("messages") # => Array<SirenClient::Entity>
+root.search(/(messages|concepts)/) # => Array<SirenClient::Entity>
 ```
 
 #### Entity sub-links

data/bin/siren_cli

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

data/lib/siren_client/action.rb

@@ -1,6 +1,7 @@
 module SirenClient
   class Action
-    attr_reader :payload, :name, :classes, :method, :href, :title, :type, :fields, :config
+    attr_accessor :href
+    attr_reader :payload, :name, :classes, :method, :title, :type, :fields, :config
 
     def initialize(data, config={})
       if data.class != Hash

data/lib/siren_client/entity.rb

@@ -1,7 +1,9 @@
 module SirenClient
   class Entity
+    include Enumerable
+    attr_accessor :href
     attr_reader :payload, :classes, :properties, :entities, :rels, 
-                :links, :actions, :title, :type, :config, :href
+                :links, :actions, :title, :type, :config
 
 
     def initialize(data, config={})
@@ -36,6 +38,23 @@ module SirenClient
       @entities.each(&block) rescue nil
     end
 
+    def search(criteria)
+      return false unless criteria
+      if criteria.is_a? String
+        return entities.select do |ent|
+          true if ent.classes.include?(criteria) || 
+                  ent.rels.include?(criteria) || 
+                  ent.href == criteria
+        end
+      elsif criteria.is_a? Regexp
+        return entities.select do |ent|
+          true if ent.classes.any? { |klass| criteria.match(klass) } ||
+                  ent.rels.any? { |rel| criteria.match(rel) } ||
+                  criteria.match(ent.href)
+        end
+      end
+    end
+
     ### Entity sub-links only
     def go
       return if self.href.empty?
@@ -51,15 +70,16 @@ module SirenClient
       end
       # Does it match an entity sub-link's class? 
       @entities.each do |ent|
-        return ent.go if ent.href && ent.classes.include?(method_str)
+        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.
       @links.each do |key, link|
-        return link.go if method_str == key
+        return link.go if method_str == key.underscore
       end
       # Does it match an action, if so return the action.
       @actions.each do |key, action|
-        return action if method_str == key
+        return action if method_str == key.underscore
       end
       raise NoMethodError, 'The method does not match a property, action, or link on SirenClient::Entity.'
     end
@@ -90,7 +110,7 @@ module SirenClient
           hash_rel = rel and break
         end
         # Ensure the rel name is a valid hash key
-        hash[hash_rel.underscore] = link
+        hash[hash_rel] = link
         hash
       end
       @actions = @payload['actions'] || []
@@ -100,7 +120,7 @@ module SirenClient
       # Convert actions into a hash
       @actions = @actions.inject({}) do |hash, action|
         next unless action.name
-        hash[action.name.underscore] = action
+        hash[action.name] = action
         hash
       end
       @title = @payload['title'] || ''

data/lib/siren_client/link.rb

@@ -1,6 +1,7 @@
 module SirenClient
   class Link
-    attr_reader :payload, :rels, :href, :title, :type, :config
+    attr_accessor :href
+    attr_reader :payload, :rels, :title, :type, :config
     
     def initialize(data, config={})
       if data.class != Hash

data/lib/siren_client/version.rb

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

data/siren_client.gemspec

@@ -24,9 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sinatra"
-  spec.add_development_dependency "sinatra-simple-auth"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "byebug" if RUBY_VERSION > "2"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
 end

data/spec/helper/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'byebug'
+require 'byebug' if RUBY_VERSION > '2'
 require 'siren_client'
 
 RSpec.configure do |config|
@@ -32,6 +32,12 @@ def siren_body
             'class' => ['concepts', 'collection'],
             'rel' => ['/rels/concepts'],
             'href' => '/graphs/test2/concepts'
+          },
+          {
+            # Just to test the underscore transformation
+            'class' => ['user-preferences', 'collection'],
+            'rel' => ['/rels/user-preferences'],
+            'href' => '/graphs/user/preferences'
           }
         ],
         'links' => [
@@ -71,7 +77,7 @@ def siren_body
         ]
       },
       {
-        'name' => 'filter_messages',
+        'name' => 'filter-messages',
         'method' => 'GET',
         'href' => '/graphs/test1/messages',
         'title' => 'Get an optionally filtered list of Messages',
@@ -103,6 +109,10 @@ def siren_body
         'rel' => ['self'],
         'href' => '/graphs?limit=1&page=1&order_by=name'
       },
+      {
+        'rel' => ['prev-page'],
+        'href' => '/graphs?limit=1&page=0&order_by=name'
+      },
       {
         'rel' => ['next'],
         'href' => '/graphs?limit=1&page=2&order_by=name'

data/spec/support/test_server.rb

@@ -14,4 +14,4 @@ class TestServer < Sinatra::Base
 end
 
 # Require all the endpoint files that build the api.
-Dir[__dir__ + "/endpoints/*.rb"].each {|file| require file }
+Dir[File.expand_path(File.dirname(__FILE__)) + "/endpoints/*.rb"].each {|file| require file }

data/spec/unit/action_spec.rb

@@ -52,6 +52,10 @@ describe SirenClient::Action do
     it 'is a string' do
       expect(action.href).to be_a String
     end
+    it 'can change .href as needed' do
+        action.href = action.href + '?query=test'
+        expect(/query=test/).to match(action.href)
+    end
   end
   describe '.title' do
     it 'is a string' do

data/spec/unit/entity_spec.rb

@@ -112,6 +112,10 @@ describe SirenClient::Entity do
     it 'should be empty' do
       expect(entity.href).to eq('')
     end
+    it 'can change .href as needed' do
+        entity.href = 'http://example.com?query=test'
+        expect(/query=test/).to match(entity.href)
+    end
   end
   # Similar to SirenClient::Link.go this function will create a 
   # new entity from the .href method. For entity sub-links only.
@@ -167,13 +171,182 @@ describe SirenClient::Entity 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
+  let (:graph) { entity[0] } 
+  describe '.search("messages")' do
+    it 'returns an Array' do
+      expect(graph.search('messages')).to be_a Array
+    end
+    it 'returns an Array of the right size' do
+      expect(graph.search('messages').length).to eq(1)
+    end
+    it 'the first element is a SirenClient::Entity' do
+      expect(graph.search('messages')[0]).to be_a SirenClient::Entity
+    end
+    it 'the first element\'s classes include "messages"' do
+      expect(graph.search('messages')[0].classes.include?('messages')).to eq(true)
+    end
+  end
+  describe '.string(/test1/)' do
+    it 'returns an Array' do
+      expect(graph.search(/test1/)).to be_a Array
+    end
+    it 'returns an Array of the right size' do
+      expect(graph.search(/test1/).length).to eq(1)
+    end
+    it 'the second element is a SirenClient::Entity' do
+      expect(graph.search(/test1/)[0]).to be_a SirenClient::Entity
+    end
+    it 'the second element\'s classes include "concepts"' do
+      expect(graph.search(/test1/)[0].classes.include?('messages')).to eq(true)
+    end
+  end
+  describe '.string(/test[0-9]/)' do
+    it 'returns an Array' do
+      expect(graph.search(/test[0-9]/)).to be_a Array
+    end
+    it 'returns an Array of the right size' do
+      expect(graph.search(/test[0-9]/).length).to eq(2)
+    end
+    it 'the second element is a SirenClient::Entity' do
+      expect(graph.search(/test[0-9]/)[1]).to be_a SirenClient::Entity
+    end
+    it 'the second element\'s classes include "concepts"' do
+      expect(graph.search(/test[0-9]/)[1].classes.include?('concepts')).to eq(true)
+    end
+  end
+  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
+    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
+    end
+  end
+  # Entities enumerable support
+  describe "enumerable support" do
+    describe '.each' do
+      it 'can iterate over all the entities' do
+        expect {
+          graph.each do |ent|
+            expect(ent).to be_a SirenClient::Entity
+          end
+        }.to_not raise_error
+      end
+    end
+    # Useful enumerable methods
+    describe '.all?' do 
+      it 'matches .entities.all?' do
+        expect(
+          graph.all? do |ent|
+            ent == SirenClient::Entity
+          end
+        ).to eq(
+          graph.entities.all? do |ent|
+              ent == SirenClient::Entity
+          end
+        )
+      end
+    end
+    describe '.find' do
+      it 'matches .entities.find' do
+        expect(
+          graph.find do |ent|
+            ent.rels.include?('/rels/messages')
+          end
+        ).to eq(
+          graph.entities.find do |ent|
+            ent.rels.include?('/rels/messages')
+          end
+        )
+      end
+    end
+    describe '.find_all' do
+      it 'matches .entities.find_all' do
+        expect(
+          graph.find_all do |ent|
+            ent.classes.include?('collection')
+          end
+        ).to eq(
+          graph.entities.find_all do |ent|
+            ent.classes.include?('collection')
+          end
+        )
+      end
+    end
+    describe '.first' do
+      it 'matches .entities.first' 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(
+          graph.map do |ent|
+            ent.classes.include?('concepts')
+          end
+        ).to eq(
+          graph.entities.map do |ent|
+            ent.classes.include?('concepts')
+          end
+        )
+      end
+    end
+    describe '.reject' do
+      it 'matches .entities.reject' do
+        expect(
+          graph.reject do |ent|
+            ent.classes.include?('messages')
+          end
+        ).to eq(
+          graph.entities.reject do |ent|
+            ent.classes.include?('messages')
+          end
+        )
+      end
+    end
+    describe '.select' do
+      it 'matches .entities.select' do
+        expect(
+          graph.select do |ent|
+            ent.rels.include?('/rels/concepts')
+          end
+        ).to eq(
+          graph.entities.select do |ent|
+            ent.rels.include?('/rels/concepts')
+          end
+        )
+      end
+    end
+    describe '.sort' do
+      it 'matches .entities.sort' do
+        expect(
+          graph.sort do |ent_a, ent_b|
+            ent_b.classes[0] <=> ent_a.classes[0]
+          end
+        ).to eq(
+          graph.entities.sort do |ent_a, ent_b|
+            ent_b.classes[0] <=> ent_a.classes[0]
+          end
+        )
+      end
     end
   end
 end

data/spec/unit/link_spec.rb

@@ -33,6 +33,10 @@ describe SirenClient::Link do
     it 'is a string' do
       expect(link.href).to be_a String
     end
+    it 'can change .href as needed' do
+        link.href = link.href + '?query=test'
+        expect(/query=test/).to match(link.href)
+    end
   end
   describe '.title' do
     it 'is a string' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siren_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chason Choate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !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
@@ -173,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -222,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A client to traverse Siren APIs https://github.com/kevinswiber/siren