ruby-json-home 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b704a0ba185c79406a60d9a7147bea2c1b36fb8
+  data.tar.gz: 4b7fe113fb946fa877ab4bf388b0f9541f0faa0c
+SHA512:
+  metadata.gz: e01d8abe49854076bda23d795766d22a25d6f98fd7438a461b25b47d5559a50869211e618578478639a1ff8c0d977d099e9c9b4785554ecceb7b80bfdbeeb6a7
+  data.tar.gz: 2a4bb75b3fca97dc78049d696531354e2b4fe9e5ff8e2ed3d95af51c8d4a8e65deefaff6bf74ecf396999f62247fb161b2a729c913ec76864823c107fb264dd5

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,2 @@
+ruby-json-home
+==============

data/Rakefile

@@ -0,0 +1,34 @@
+#   Copyright 2014 innoQ Deutschland GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::RDocTask.new do |rdoc|
+  files = ['README.md', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.md" # page to start on
+  rdoc.title = "RubyJSONHome Documentation"
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end
+
+task :default => :test

data/lib/json_home.rb

@@ -0,0 +1,103 @@
+#   Copyright 2011 innoQ Deutschland GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'net/http'
+require 'json'
+
+class JSONHome
+
+  attr_reader :base_uri
+
+  class << self
+    attr_accessor :logger, :ignore_http_errors
+  end
+
+  def initialize(base_uri, local_resources = nil)
+    @base_uri = URI.parse(base_uri)
+    @resources = {}
+    reload(local_resources)
+  end
+
+  def reload(local_resources = nil)
+    Net::HTTP.start(base_uri.host, base_uri.port) do |http|
+      req = if local_resources.is_a?(Hash)
+        r = Net::HTTP::Put.new(base_uri.request_uri)
+        r.body = JSON.generate("resources" => local_resources.each_with_object({}) { |(k, v), memo|
+            k = "http://helloworld.innoq.com/#{k}" unless k.to_s.include?("/")
+            memo[k] = v
+          })
+        r["Content-Type"] = "application/json"
+        r
+      else
+        Net::HTTP::Get.new(base_uri.request_uri)
+      end
+      req['Accept'] = "application/json-home"
+      res = http.request(req)
+      if res.is_a?(Net::HTTPSuccess)
+        @resources = JSON.parse(res.body)["resources"] || {}
+        JSONHome.logger && JSONHome.logger.info("Found ForeignLinks: #{@resources.keys.inspect}")
+      else
+        raise RuntimeError.new("HTTP error: '#{res.code} #{res.message}'")
+      end
+    end
+  rescue Net::HTTPExceptions, Errno::ECONNREFUSED, RuntimeError => e
+    if JSONHome.ignore_http_errors
+      puts e
+      JSONHome.logger && JSONHome.logger.error(e)
+      @resources = {}
+    else
+      raise e
+    end
+  end
+
+  def uri(resource, params = {})
+    JSONHome.uri(@resources, resource, params)
+  end
+
+  def uri?(resource)
+    JSONHome.uri?(@resources, resource)
+  end
+
+  def self.uri(resources, resource, params = {})
+    unless uri?(resources, resource)
+      JSONHome.logger && JSONHome.logger.warn("Couldn't find valid JSON home data for '#{resource}'")
+      return nil
+    end
+
+    params = params.inject({}) { |h, (k, v)| h.merge(k.to_s => v)  }
+
+    data = resources[resource.to_s]
+    if data["href"].is_a?(String)
+      data["href"].to_s
+    elsif data["href-template"].is_a?(String)
+      uri = data["href-template"].to_s
+      unknown_keys = (params.keys - data["href-vars"].keys)
+      JSONHome.logger && JSONHome.logger.warn("Unknown keys #{unknown_keys.inspect} in ForeignLinks#uri call") if unknown_keys.any?
+      data["href-vars"].each do |key, type_uri|
+        JSONHome.logger && JSONHome.logger.warn("Missing key '#{key}' in ForeignLinks#uri call") unless params[key]
+        uri = uri.gsub("{#{key}}", params[key].to_s)
+      end
+      uri
+    end
+  end
+
+  def self.uri?(resources, resource)
+    data = resources[resource.to_s]
+    data.is_a?(Hash) && (
+      data["href"].is_a?(String) ||
+          (data["href-template"].is_a?(String) && data["href-vars"].is_a?(Hash))
+    )
+  end
+
+end

data/lib/ruby-json-home.rb

@@ -0,0 +1,31 @@
+#   Copyright 2011 innoQ Deutschland GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'logger'
+
+require 'json_home'
+
+module RubyJSONHome
+
+  VERSION = '0.0.1'
+
+end
+
+
+if Kernel.const_defined?(:Rails)
+  JSONHome.ignore_http_errors = Rails.env.development?
+  JSONHome.logger = Rails.logger
+else
+  JSONHome.logger = Logger.new(STDOUT)
+end

data/ruby-json-home.gemspec

@@ -0,0 +1,36 @@
+#   Copyright 2014 innoQ Deutschland GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-json-home"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-json-home"
+  s.version     = RubyJSONHome::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Till Schulte-Coerne"]
+  s.email       = ["till.schulte-coerne@innoq.com"]
+  s.homepage    = "http://github.com/innoq/ruby-json-home"
+  s.summary     = "A client for json-home"
+  s.description = s.summary
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+
+  s.add_dependency "bundler"
+
+  s.files = %w(LICENSE README.md Rakefile ruby-json-home.gemspec) + Dir.glob("{lib,test}/**/*")
+  s.test_files = Dir.glob("{test}/**/*")
+  s.executables = Dir.glob("{bin}/**/*")
+  s.require_paths = ["lib"]
+end

data/test/basics_test.rb

@@ -0,0 +1,38 @@
+#   Copyright 2011 innoQ Deutschland GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'test_helper'
+
+class BasicsTest < Minitest::Test
+
+  def setup
+    stub_request(:get, "www.example.com").
+        with(:headers => { 'Accept' => 'application/json-home' }).
+        to_return(:body => File.new(File.join(File.dirname(__FILE__), 'test-data.json')), :status => 200)
+  end
+
+  def test_simple_functionality
+    jh = JSONHome.new("http://www.example.com")
+
+    assert jh.uri?("http://example.org/rel/widgets"), "URI 'http://example.org/rel/widgets' should be defined"
+    assert_equal("/widgets/", jh.uri("http://example.org/rel/widgets"))
+
+    assert jh.uri?("http://example.org/rel/widget"), "URI 'http://example.org/rel/widget' should be defined"
+    assert_equal("/widgets/4711", jh.uri("http://example.org/rel/widget", :widget_id => 4711))
+    assert_equal("/widgets/1234", jh.uri("http://example.org/rel/widget", "widget_id" => 1234))
+  end
+
+end

data/test/test-data.json

@@ -0,0 +1,20 @@
+{
+  "resources": {
+    "http://example.org/rel/widgets": {
+      "href": "/widgets/"
+    },
+    "http://example.org/rel/widget": {
+      "href-template": "/widgets/{widget_id}",
+      "href-vars": {
+        "widget_id": "http://example.org/param/widget"
+      },
+      "hints": {
+        "allow": ["GET", "PUT", "DELETE", "PATCH"],
+        "representations": ["application/json"],
+        "accept-patch": ["application/json-patch"],
+        "accept-post": ["application/xml"],
+        "accept-ranges": ["bytes"]
+      }
+    }
+  }
+}

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+#   Copyright 2014 innoQ Deutschland GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+
+require 'ruby-json-home'
+JSONHome.logger = nil

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: ruby-json-home
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Till Schulte-Coerne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for json-home
+email:
+- till.schulte-coerne@innoq.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- ruby-json-home.gemspec
+- lib/json_home.rb
+- lib/ruby-json-home.rb
+- test/basics_test.rb
+- test/test-data.json
+- test/test_helper.rb
+homepage: http://github.com/innoq/ruby-json-home
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A client for json-home
+test_files:
+- test/basics_test.rb
+- test/test-data.json
+- test/test_helper.rb