json_roa-client 1.0.0.pre.beta.1 → 1.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a343d233e0c8c79b865158eefdfa6294c079ba80
-  data.tar.gz: d3c1da41839add17ac785165b4e3e8696d1352b3
+  metadata.gz: 46382a4f2f15aff6db0a65d35cf46f7a6dab4ccc
+  data.tar.gz: f64826275e7ce06c69deac16ddaad67b997fe103
 SHA512:
-  metadata.gz: f1e660f2cbe03948725619ebee7f7d53467207f64119e693ea60c17f09197d21c9c573d46849dbef057c46ea7ec4e9cf924da18e4d3ad82121441cd858773894
-  data.tar.gz: cdae12606a74ce5a99b3ee3928cab9877500209292f719208db32090f0c22df9d9d49cc09ccc6c69e603a7414aaac5d1db2842d44a09028dc041ab4ff0b98fe5
+  metadata.gz: 70cd3d8b62f0ad4d6557cdbb635b9487ccca60868c3d17002552b343967ce16041fa1da3d5b734d539d8a47d25e3983ee2b590a18903bf8183bcc27c2bdd2934
+  data.tar.gz: 804362c743bef126bf91fc7b5bd8726d239caa5aca1e07a2f4aa3824df9e4ad1e9a1366d7b845da9d578317d1e7f0c4f32ef08e4f9a334e6315c96d32c3ea249

data/README.md

@@ -1,6 +1,35 @@
 # Ruby JSON-ROA Client
 
-A ruby client for `JSON_ROA`.
+A ruby client for `JSON-ROA`.
+
+## Semantic Versioning and Rubygems Versioning
+
+This library is _BETA_ because the [JSON-ROA specifciation][] itself is
+_BETA_. This library uses [Semantic Versioning][] and the current version
+is [1.0.0-beta.2](./lib/json_roa/client/version.rb).
+
+The rubygems system [claims also to use semantic versioning][] and even *urges
+gem developers to follow it*. Rubygems transforms the version as given above
+into `1.0.0.pre.beta.1`. Any work using this library should specify the
+following in the Gemfile 
+
+    gem 'json_roa-client', '= 1.0.0.pre.beta.2' 
+
+or the following in the gemspec 
+
+    spec.add_runtime_dependency 'json_roa-client', '= 1.0.0.pre.beta.2'
+
+In the latter case, building the gem will result in a warning because of the
+prerelease. You can safely ignore this warning. It is in the context of
+semantic versioning misleading. However, it is important to fix the dependency
+by using the `=` sign. In this case, violation would warrant a warning. 
+
+
+
+
+  [JSON-ROA specifciation]: http://json-roa.github.io/specification.html
+  [Semantic Versioning]: http://semver.org/
+  [claims also to use semantic versioning]: http://guides.rubygems.org/patterns/#semantic-versioning
 
 ## Usage
 

data/lib/json_roa/client/relation.rb

@@ -26,9 +26,18 @@ module JSON_ROA
         end
       end
 
+      def assert_proper_query_parameters! query_parameters, template
+        unless Set.new(query_parameters.keys).subset? Set.new(template.keys)
+          raise StandardError, ["query_parameters", query_parameters.keys.to_s,
+                                "do not match template parameters",
+                                template.keys.to_s].join(" ") 
+        end
+      end
+
       def run_request method, query_parameters, body, headers, &block
         href= @data['href']
         template= ::Addressable::Template.new(href) 
+        assert_proper_query_parameters! query_parameters, template
         expanded_url= template.expand(query_parameters)
         response=@conn.run_request( \
           method.to_sym, expanded_url, body, headers, &block)

data/lib/json_roa/client/version.rb

@@ -1,5 +1,5 @@
 module JSON_ROA
   module Client
-    VERSION = "1.0.0-beta.1"
+    VERSION = "1.0.0-beta.2"
   end
 end

data/spec/data/root.yml

@@ -3,7 +3,7 @@ _json-roa:
   version: 0.0.0
   relations: 
     tasks:
-      href: /tasks/
+      href: /tasks/{?x,y}
     task: 
       href: /tasks/{id}
       methods:

data/spec/methods_spec.rb

@@ -7,7 +7,7 @@ describe "methods of the relation /tasks/t1" do
   end
 
   subject(:task1_self_relation) \
-    {root_relation.get().relation("task").get(id: "t1").self_relation}
+    {root_relation.get().relation("task").get("id" => "t1").self_relation}
 
   it "is a relation" do 
     expect(task1_self_relation.class).to be== JSON_ROA::Client::Relation

data/spec/template_expansion_spec.rb

@@ -1,27 +1,51 @@
 require_relative 'spec_helper.rb'
 
-describe "template expansion of task with id" do
+describe "template expansion" do
 
   let :root_relation do 
     JSON_ROA::Client.connect("/")
   end
 
-  subject(:task_relation) {root_relation.get().relation("task")}
+  context "task relation" do
 
-  it "is a relation" do 
-    expect(task_relation.class).to be== JSON_ROA::Client::Relation
-  end
+    subject(:task_relation) {root_relation.get().relation("task")}
+
+    it "is a relation" do 
+      expect(task_relation.class).to be== JSON_ROA::Client::Relation
+    end
+
+    it "is templated" do
+      expect(task_relation.data['href']).to be== "/tasks/{id}"
+    end
+
+    describe "get with parameter to expand" do
+      subject(:task_resource){task_relation.get("id" => "t1")}
+
+      it "is a resource of t1" do
+        expect(task_resource.class).to be== JSON_ROA::Client::Resource
+        expect(task_resource.self_relation.data["href"]).to be== "/tasks/t1"
+      end
+
+    end
 
-  it "is templated" do
-    expect(task_relation.data['href']).to be== "/tasks/{id}"
   end
 
-  describe "get with parameter to expand" do
-    subject(:task_resource){task_relation.get(id: "t1")}
+  context "tasks relation" do
+
+    subject(:tasks_relation) {root_relation.get().relation("tasks")}
+
+    describe "get with existing parameter to expand" do
+      it "does not raise an error" do
+        expect{ tasks_relation.get("x" => "foo")
+        }.not_to raise_error 
+      end
+    end
 
-    it "is a resource of t1" do
-      expect(task_resource.class).to be== JSON_ROA::Client::Resource
-      expect(task_resource.self_relation.data["href"]).to be== "/tasks/t1"
+    describe "get with a non-existing parameter to expand" do
+      it "raises an error" do
+        expect{ tasks_relation.get("non_existing_query_parameter" => "foo")
+        }.to raise_error /query_parameters .* do not match template parameters/
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_roa-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.1
+  version: 1.0.0.pre.beta.2
 platform: ruby
 authors:
 - Thomas Schank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler