json_roa-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4d7651511267f0efcb676968189e34177b9f6d2
+  data.tar.gz: d4e9af5a21128239ab328f7e067c2e4d95c069d6
+SHA512:
+  metadata.gz: fea1c51ea58d00a4d1f463c8b27305ebcebce2dd3ce5b4b50a67b17c69e48f43d0eedae98d384882fb2d1fc822c78d5926049f6d354feeb895a21a8e78c8b20c
+  data.tar.gz: ac5ec164e6903eef845ea64a42b454ea775deaf94a0cd2da8fb0b35017e05d9d83d63d8abad2d2627c077210b4aaea1da607687db5df2cf1d5e121edb72b28bc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_roa-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Schank
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Ruby JSON-ROA Client
+
+A ruby client for `JSON_ROA`.
+
+## Usage
+
+### Connecting 
+
+```ruby
+require 'json_roa/client'
+
+@root_resource = JSON_ROA::Client.connect @base_url do |conn|
+  conn.basic_auth(@username,@password)
+end
+```
+
+`conn` is a [Faraday][] connection.
+
+
+###  Resources 
+
+#### Data
+
+```ruby
+@root_resource.data
+```
+
+#### JSON-ROA Data
+
+```ruby
+@root_resource.json_roa_data
+```
+
+### Relations
+
+```ruby
+@root_resource.relation('execution')
+```
+
+#### Resource of a Relation
+
+In this case the relation is based on an [URI Template][] and we
+must provide an `id` parameter.
+
+```ruby
+@execution_resource= @root_resource.relation('execution').get('id' => '55744c40-b764-4fd4-98e2-7a69bc57f496')
+```
+
+### Collections
+
+A resource that is conceptual an *index* can be processed as an
+[Enumerable][] of its relations. The client will abstract pagination
+away.
+
+```ruby
+@root_resource.relation('executions').get.collection.each do |execution_relation| 
+  puts execution_relation.get.data
+end
+```
+
+  [Enumerable]: http://ruby-doc.org/core-2.1.0/Enumerable.html
+  [URI Template]: http://tools.ietf.org/html/rfc6570
+  [Faraday]: https://github.com/lostisland/faraday
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/json_roa-client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_roa/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_roa-client"
+  spec.version       = JSON_ROA::Client::VERSION
+  spec.authors       = ["Thomas Schank"]
+  spec.email         = ["DrTom@schank.ch"]
+  spec.summary       = "The Ruby JSON-ROA Client Reference Implementation"
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+
+  spec.add_dependency 'addressable', '~> 2'
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  # spec.add_dependency "pry", "~> 0.10"
+
+end

data/lib/json_roa/client/collection.rb

@@ -0,0 +1,29 @@
+module JSON_ROA
+  module Client
+
+    class Collection
+      include Enumerable
+
+      def initialize conn, resource
+        @conn= conn
+        @resource= resource
+      end
+
+      def each &block
+        relations= @resource.response.env \
+          .json_roa_data['collection']['relations'] rescue []
+        relations.each do |key, data|
+          yield Relation.new(@conn,key,data) if block_given? 
+        end
+
+        next_val= @resource.response \
+          .env.json_roa_data['collection']['next'] rescue nil
+        if next_val 
+          Relation.new(@conn,"next",next_val).get().collection.each(&block)
+        end
+
+      end
+    end
+
+  end
+end

data/lib/json_roa/client/relation.rb

@@ -0,0 +1,34 @@
+require 'addressable/template'
+require 'addressable/uri'
+
+module JSON_ROA
+  module Client
+
+    class Relation
+
+      attr_reader :data
+      attr_reader :key
+
+      def initialize conn, key, data 
+        @conn= conn
+        @key= key
+        @data= data
+      end
+
+      def get query_parameters= {}
+        href= @data['href']
+        template= ::Addressable::Template.new(href) 
+        expanded= template.expand(query_parameters)
+        response=@conn.get(expanded)
+        ::JSON_ROA::Client::Resource.new(@conn,response)
+      end
+
+      def methods 
+        @data['methods']
+      end
+
+    end
+
+  end
+end
+

data/lib/json_roa/client/resource.rb

@@ -0,0 +1,40 @@
+require "json_roa/client/relation"
+require "json_roa/client/collection"
+
+module JSON_ROA
+  module Client
+
+    class Resource
+
+      attr_reader :response
+
+      def initialize conn, response = nil
+        @conn= conn
+        @response= response || conn.get
+      end
+
+      def relation key
+        relhash= @response.env.json_roa_data['relations'][key]
+        ::JSON_ROA::Client::Relation.new @conn, key, relhash
+      end
+
+      def relations_data
+        @response.env.json_roa_data['relations']
+      end
+
+      def data
+        @response.body
+      end
+
+      def json_roa_data
+        @response.env.json_roa_data
+      end
+
+      def collection
+        ::JSON_ROA::Client::Collection.new @conn, self 
+      end
+    end
+
+  end
+end
+

data/lib/json_roa/client/version.rb

@@ -0,0 +1,5 @@
+module JSON_ROA
+  module Client
+    VERSION = "0.0.1"
+  end
+end

data/lib/json_roa/client.rb

@@ -0,0 +1,43 @@
+require "json_roa/client/version"
+require "json_roa/client/resource"
+require 'faraday'
+require 'faraday_middleware'
+
+module JSON_ROA
+
+  class Middleware < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |env|
+        env.class.class_eval do |klass|
+          attr_accessor :json_roa_data
+        end
+        env.json_roa_data= env.body.delete("_json-roa")
+      end
+    end
+  end
+
+  module Client
+
+    class << self 
+
+      def connect url, &block 
+
+        @conn= Faraday.new(url: url,
+                              headers: {accept: "application/json-roa+json"}) do |conn|
+          conn.use ::JSON_ROA::Middleware
+          conn.response :json, :content_type => /\bjson$/
+          conn.request :retry
+          conn.use Faraday::Response::RaiseError
+          conn.adapter Faraday.default_adapter  
+        end
+
+        yield @conn if block_given?
+
+        Resource.new @conn
+
+      end
+
+    end
+  end
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: json_roa-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Schank
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: ''
+email:
+- DrTom@schank.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_roa-client.gemspec
+- lib/json_roa/client.rb
+- lib/json_roa/client/collection.rb
+- lib/json_roa/client/relation.rb
+- lib/json_roa/client/resource.rb
+- lib/json_roa/client/version.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: The Ruby JSON-ROA Client Reference Implementation
+test_files: []