grape-hypertext_application_language 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b245bf5afb49fb907aad0b188ab89afee06abda
+  data.tar.gz: dd47cc9a8a73b730f6ab26fcf07c3af905b51c65
+SHA512:
+  metadata.gz: 5145c5bb772a3a1d9067a8416c651b6e463249ee3a0170256642033a5917ade612b91f551b57c5785a064499d807dd3dcbb493742acb72d9f4d8df7f38b1514d
+  data.tar.gz: 1635e2f63cb76132bed732fbd73e788d792063e381e0a840b27b45e8fcbd5fec0f7385e363ece17a63ad9020198e451156b2b2783c03d2ec5c1fd5a6f4eafed3

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    grape-hypertext_application_language (0.0.0)
+      addressable
+      grape
+      hypertext_application_language
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    grape (0.13.0)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    hashie (3.4.3)
+    hypertext_application_language (0.0.1)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.3)
+    json (1.8.3-java)
+    minitest (5.8.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    rack (1.6.4)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rake (10.4.2)
+    thread_safe (0.3.5)
+    thread_safe (0.3.5-java)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler
+  grape-hypertext_application_language!
+  rake
+
+BUNDLED WITH
+   1.10.6

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/grape-hypertext_application_language.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name = 'grape-hypertext_application_language'
+  spec.version = '0.0.0'
+  spec.summary = %q{Grape extensions for Hypertext Application Language}
+  spec.description = %q{}
+  spec.homepage = 'http://stateless.co/hal_specification.html'
+  spec.authors = ['Roy Ratcliffe']
+  spec.email = ['roy@pioneeringsoftware.co.uk']
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.license = 'MIT'
+
+  spec.add_dependency 'grape'
+  spec.add_dependency 'hypertext_application_language'
+  spec.add_dependency 'addressable'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/grape-hypertext_application_language.rb

@@ -0,0 +1,2 @@
+require 'grape/hal/content_types'
+require 'grape/hal/formatter'

data/lib/grape/formatter/hal/json.rb

@@ -0,0 +1,45 @@
+require 'grape'
+require 'hypertext_application_language'
+require 'addressable/uri'
+require 'json'
+
+module Grape::Formatter::Hal
+  class Json
+    # Formats a Grape end-point body using JSON-formatted hypertext application
+    # language. Assumes that the body is a hypertext-application-language
+    # representation, either a resource or collection of resources.
+    #
+    # Derives the end-point's request URL using only the plain Rack environment
+    # if necessary; doing so assumes nothing about any higher-level framework,
+    # e.g. Grape or Sinatra. Uses the base URL to adjust all the relative
+    # hypertext references. They become absolute references; meaning not
+    # relative, i.e. the reference does not include a scheme. Applies this
+    # adjustment to the representation itself as well as all the embedded
+    # representations if any.
+    #
+    # Automatically converts the body to a hypertext-application-language
+    # representation unless the body is already such a HAL
+    # representation. Passes the Rack environment to the HAL
+    # converter. Converters can use the environment to extract addressing
+    # information for the representation's links, including the self link.
+    def self.call(body, env)
+      unless body.is_a?(HypertextApplicationLanguage::Representation)
+        return body unless body.respond_to?(:to_hal)
+        body = body.to_hal(env: env)
+      end
+
+      endpoint = env['api.endpoint']
+      request = endpoint ? endpoint.request : Rack::Request.new(env)
+      base_uri = Addressable::URI.parse(request.base_url + request.script_name + '/')
+
+      representations = [body] + body.representations
+      representations.map(&:links).flatten.each do |link|
+        uri = Addressable::URI.parse(link.href)
+        link.href = base_uri.join(uri).to_s unless uri.absolute?
+      end
+
+      renderer = HypertextApplicationLanguage::HashRepresentationRenderer.new
+      JSON.pretty_generate(renderer.render(body))
+    end
+  end
+end

data/lib/grape/hal/content_types.rb

@@ -0,0 +1,3 @@
+require 'grape'
+
+Grape::ContentTypes::CONTENT_TYPES.merge! hal_json: 'application/hal+json'

data/lib/grape/hal/formatter.rb

@@ -0,0 +1,3 @@
+require 'grape/formatter/hal/json'
+
+Grape::Formatter::Base.singleton_class.const_get(:FORMATTERS).merge! hal_json: Grape::Formatter::Hal::Json

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: grape-hypertext_application_language
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Roy Ratcliffe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: grape
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: hypertext_application_language
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: addressable
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- roy@pioneeringsoftware.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- grape-hypertext_application_language.gemspec
+- lib/grape-hypertext_application_language.rb
+- lib/grape/formatter/hal/json.rb
+- lib/grape/hal/content_types.rb
+- lib/grape/hal/formatter.rb
+homepage: http://stateless.co/hal_specification.html
+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.4.8
+signing_key:
+specification_version: 4
+summary: Grape extensions for Hypertext Application Language
+test_files: []