siren_client 0.1

data/lib/siren_client/exceptions.rb

@@ -0,0 +1,6 @@
+module SirenClient
+  class StandardError        < ::StandardError; end
+  class InvalidURIError      < StandardError; end
+  class InvalidResponseError < StandardError; end
+  class InvalidLogger        < StandardError; end
+end

data/lib/siren_client/field.rb

@@ -0,0 +1,17 @@
+module SirenClient
+  class Field
+    attr_reader :payload, :name, :type, :value, :title
+
+    def initialize(data)
+      if data.class != Hash
+        raise ArgumentError, "You must pass in a Hash to SirenClient::Action.new"
+      end
+      @payload = data
+
+      @name  = @payload['name']  || ''
+      @type  = @payload['type']  || 'text'
+      @value = @payload['value'] || ''
+      @title = @payload['title'] || ''
+    end
+  end
+end

data/lib/siren_client/link.rb

@@ -0,0 +1,22 @@
+module SirenClient
+  class Link
+    attr_reader :payload, :rels, :href, :title, :type, :config
+    
+    def initialize(data, config={})
+      if data.class != Hash
+        raise ArgumentError, "You must pass in a Hash to SirenClient::Link.new"
+      end
+      @payload = data
+      @config = { format: :json }.merge config 
+
+      @rels  = @payload['rel']   || []
+      @href  = @payload['href']  || ''
+      @title = @payload['title'] || ''
+      @type  = @payload['type']  || ''
+    end
+
+    def go
+      Entity.new(self.href, @config)
+    end
+  end
+end

data/lib/siren_client/version.rb

@@ -0,0 +1,3 @@
+module SirenClient
+  VERSION = "0.1"
+end

data/siren_client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'siren_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "siren_client"
+  spec.version       = SirenClient::VERSION
+  spec.authors       = ["Chason Choate"]
+  spec.email         = ["cha55son@gmail.com"]
+  spec.summary       = %q{A client to traverse Siren APIs https://github.com/kevinswiber/siren}
+  spec.description   = %q{SirenClient provides an ActiveRecord-like syntax to traverse Siren APIs.}
+  spec.homepage      = "https://github.com/cha55son/siren_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  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 "guard"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/helper/live_spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rack'
+require 'helper/spec_helper'
+require 'support/test_server'
+
+# Start a local rack server to serve up dummy data.
+server_thread = Thread.new do
+  Rack::Handler::WEBrick.run(
+    TestServer.new,
+    :Port => 9292,
+    :AccessLog => [],
+    :Logger => WEBrick::Log::new("/dev/null", 7)
+  )
+end
+sleep(1) # wait a sec for the server to be boot
+
+RSpec.configure do |config|
+  config.after(:suite) { 
+    server_thread.kill
+  }
+end

data/spec/helper/spec_helper.rb

@@ -0,0 +1,112 @@
+require 'byebug'
+require 'siren_client'
+
+RSpec.configure do |config|
+  # Ensure we only use `expect` and not `should`.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def siren_body
+  {
+    'class' => ['graphs', 'collection'],
+    'properties' => {
+      'page' => 1,
+      'limit' => 20
+    },
+    'entities' => [
+      {
+        'class' => ['graphs'],
+        'rel' => ['/rels/graphs'],
+        'properties' => {
+          'name' => 'test1'
+        },
+        'entities' => [
+          {
+            'class' => ['messages', 'collection'],
+            'rel' => ['/rels/messages'],
+            'href' => '/graphs/test1/messages'
+          },
+          {
+            'class' => ['concepts', 'collection'],
+            'rel' => ['/rels/concepts'],
+            'href' => '/graphs/test2/concepts'
+          }
+        ],
+        'links' => [
+          {
+            'rel' => ['self'],
+            'href' => '/graphs/test1'
+          }
+        ]
+      }
+    ],
+    'actions' => [
+      {
+        'name' => 'filter_concepts',
+        'method' => 'GET',
+        'href' => '/graphs/test1/concepts',
+        'title' => 'Get an optionally filtered list of Concepts',
+        'type' => 'application/x-www-form-urlencoded',
+        'fields' => [
+          {
+            'name' => 'limit',
+            'title' => 'Max number of results in each page',
+            'type' => 'NUMBER',
+            'required' => false
+          },
+          {
+            'name' => 'page',
+            'title' => 'Page number, starting at 1',
+            'type' => 'NUMBER',
+            'required' => false
+          },
+          {
+            'name' => 'search',
+            'title' => 'Keyword search',
+            'type' => 'TEXT',
+            'required' => true
+          }
+        ]
+      },
+      {
+        'name' => 'filter_messages',
+        'method' => 'GET',
+        'href' => '/graphs/test1/messages',
+        'title' => 'Get an optionally filtered list of Messages',
+        'type' => 'application/x-www-form-urlencoded',
+        'fields' => [
+          {
+            'name' => 'limit',
+            'title' => 'Max number of results in each page',
+            'type' => 'NUMBER',
+            'required' => false
+          },
+          {
+            'name' => 'page',
+            'title' => 'Page number, starting at 1',
+            'type' => 'NUMBER',
+            'required' => false
+          },
+          {
+            'name' => 'search',
+            'title' => 'Keyword search',
+            'type' => 'TEXT',
+            'required' => true
+          }
+        ]
+      }
+    ],
+    'links' => [
+      {
+        'rel' => ['self'],
+        'href' => '/graphs?limit=1&page=1&order_by=name'
+      },
+      {
+        'rel' => ['next'],
+        'href' => '/graphs?limit=1&page=2&order_by=name'
+      }
+    ]
+  }
+end

data/spec/live/traverse_spec.rb

@@ -0,0 +1,101 @@
+require 'helper/live_spec_helper'
+
+URL = 'http://localhost:9292'
+describe HTTParty do
+  it 'will be blocked by basic auth' do
+    expect(HTTParty.get(URL).code).to eq(401)
+  end
+  it 'can access the server' do
+    expect(HTTParty.get(URL, basic_auth: { username: 'admin', password: '1234' }).code).to eq(200)
+  end
+end
+
+describe SirenClient do
+  context 'when creating an entity' do
+    let (:headers_ent) { 
+      SirenClient.get({
+        url: URL,
+        basic_auth: { username: 'admin', password: '1234' },
+        headers: { "Accept" => "application/json" }
+      })
+    }
+    it 'can set HTTP headers' do
+      expect {
+        expect(headers_ent.config[:headers]).to be_a Hash
+        expect(headers_ent.config[:headers]).to eq({ 
+          "Accept" => "application/json"
+        })
+      }.to_not raise_error
+    end
+    it 'it\'s actions inherit the same config' do
+      expect(headers_ent.filter_concepts_get.config[:headers]).to eq({
+        "Accept" => "application/json"
+      })
+    end
+  end
+
+  let (:client) { 
+
+    SirenClient.get(
+      url: URL, 
+      timeout: 2,
+      basic_auth: { username: 'admin', password: '1234' },
+      headers: { "Accept" => "application/json" }
+    ) 
+  }
+  context 'when accessing the root entity' do
+    it 'to return an entity' do
+      expect(client).to be_a SirenClient::Entity
+    end
+    it 'to access properties' do
+      expect(client.properties['name']).to eq('Test 1')
+    end
+    it 'to not have entities' do
+      expect(client.length).to eq(0)
+    end
+  end
+  context 'when accessing a link' do
+    it 'to return a link' do
+      expect(client.links['concepts']).to be_a SirenClient::Link
+    end
+    it 'to follow the link' do
+      expect(client.concepts).to be_a SirenClient::Entity
+      expect(client.concepts.links['self'].href).to eq(URL + '/concepts')
+    end
+  end
+  context 'when accessing an action with GET' do
+    it 'to return an action' do
+      expect(client.filter_concepts_get).to be_a SirenClient::Action
+    end
+    context 'with .where' do
+      it 'to execute the action' do
+        params = { search: 'obama' }
+        expect(client.filter_concepts_get.where(params)).to be_a SirenClient::Entity
+        expect(client.filter_concepts_get.where(params).length).to eq(1)
+        expect(client.filter_concepts_get.where(params)[0]).to be_a SirenClient::Entity
+        expect(client.filter_concepts_get.where(params)[0].category).to eq('PERSON')
+      end
+    end
+  end
+  context 'when accessing an action with POST' do
+    it 'to return an action' do
+      expect(client.filter_concepts_post).to be_a SirenClient::Action
+    end
+    context 'with .where' do
+      it 'to execute the action' do
+        params = { search: 'obama' }
+        expect(client.filter_concepts_post.where(params)).to be_a SirenClient::Entity
+        expect(client.filter_concepts_post.where(params).length).to eq(1)
+        expect(client.filter_concepts_post.where(params)[0]).to be_a SirenClient::Entity
+        expect(client.filter_concepts_post.where(params)[0].category).to eq('PERSON')
+      end
+    end
+  end
+
+  let (:concepts) { SirenClient.get({ url: URL, basic_auth: { username: 'admin', password: '1234' }}).concepts }
+  context 'when accessing an entity' do
+    it 'to return an entity' do
+      expect(concepts).to be_a SirenClient::Entity
+    end
+  end
+end

data/spec/support/endpoints/concepts.rb

@@ -0,0 +1,85 @@
+class TestServer < Sinatra::Base
+  CON_1 = <<-EOF
+    {  
+      "class":["concepts"],
+      "rel":["/rels/concepts"],
+      "properties":{  
+        "text":"barack obama",
+        "category":"PERSON"
+      },
+      "links":[  
+        {  
+          "rel":["self"],
+          "href":"#{@@url}/concepts/1"
+        }
+      ]
+    }
+  EOF
+  CON_2 = <<-EOF
+    {  
+      "class":["concepts"],
+      "rel":["/rels/concepts"],
+      "properties":{  
+        "text":"tennessee",
+        "category":"LOCATION"
+      },
+      "links":[  
+        {  
+          "rel":["self"],
+          "href":"#{@@url}/concepts/2"
+        }
+      ]
+    }
+  EOF
+  post '/concepts/?' do
+    query = (request.query_string.length > 0 ? '?' : '') + request.query_string
+    <<-EOF
+      {
+        "class":["concepts","collection"],
+        "properties": { "count": 1 },
+        "entities": [#{CON_1}],
+        "links": [
+          {
+            "rel": ["self"],
+            "href": "#{@@url}/concepts#{query}"
+          }
+        ]
+      }
+    EOF
+  end
+  get '/concepts/?' do
+    query = (request.query_string.length > 0 ? '?' : '') + request.query_string
+    # search=obama
+    if request.params['search']
+      <<-EOF
+        {
+          "class":["concepts","collection"],
+          "properties": { "count": 1 },
+          "entities": [#{CON_1}],
+          "links": [
+            {
+              "rel": ["self"],
+              "href": "#{@@url}/concepts#{query}"
+            }
+          ]
+        }
+      EOF
+    else
+      <<-EOF
+        {  
+          "class":["concepts","collection"],
+          "properties":{  
+            "count":2
+          },
+          "entities":[#{CON_1}, #{CON_2}],
+          "links":[  
+            {  
+              "rel":["self"],
+              "href":"#{@@url}/concepts#{query}"
+            }
+          ]
+        }
+      EOF
+    end
+  end
+end

data/spec/support/endpoints/root.rb

@@ -0,0 +1,101 @@
+class TestServer < Sinatra::Base
+  get '/?' do
+    <<-EOF
+      {
+        "properties": {
+          "page": 1,
+          "name": "Test 1"
+        },
+        "links": [
+          {
+            "rel": ["self"],
+            "href":"#{@@url}/"
+          },
+          {
+            "rel": ["collection", "concepts"], 
+            "href":"#{@@url}/concepts",
+            "title": "Concepts"
+          },
+          { "rel": ["messages", "collection"],
+            "href": "#{@@url}/messages",
+            "title":"Messages"
+          }
+        ],
+        "actions": [  
+          {  
+            "name":"filter-concepts-get",
+            "method":"GET",
+            "href":"#{@@url}/concepts",
+            "title":"Get an optionally filtered list of Concepts",
+            "type":"application/x-www-form-urlencoded",
+            "fields":[  
+              {  
+                "name":"limit",
+                "title":"Max number of results in each page",
+                "type":"number"
+              },
+              {  
+                "name":"page",
+                "title":"Page number, starting at 1",
+                "type":"number"
+              },
+              {  
+                "name":"search",
+                "title":"Keyword search on concept text",
+                "type":"text"
+              }
+            ]
+          },
+          {  
+            "name":"filter-concepts-post",
+            "method":"POST",
+            "href":"#{@@url}/concepts",
+            "title":"Get an optionally filtered list of Concepts",
+            "type":"application/x-www-form-urlencoded",
+            "fields":[  
+              {  
+                "name":"limit",
+                "title":"Max number of results in each page",
+                "type":"number"
+              },
+              {  
+                "name":"page",
+                "title":"Page number, starting at 1",
+                "type":"number"
+              },
+              {  
+                "name":"search",
+                "title":"Keyword search on concept text",
+                "type":"text"
+              }
+            ]
+          },
+          {  
+            "name":"filter-messages",
+            "method":"GET",
+            "href":"#{@@url}/messages",
+            "title":"Get an optionally filtered list of Messages",
+            "type":"application/x-www-form-urlencoded",
+            "fields":[  
+              {  
+                "name":"limit",
+                "title":"Max number of results in each page",
+                "type":"number"
+              },
+              {  
+                "name":"page",
+                "title":"Page number, starting at 1",
+                "type":"number"
+              },
+              {  
+                "name":"search",
+                "title":"Keyword search on message body",
+                "type":"number"
+              }
+            ]
+          }
+        ]
+      }
+    EOF
+  end
+end