grape-hal 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGIyNjRkMTU5MDdhNTMzY2UyZjE2NzVjNDViMzcyZWMwZGMwZTUwNw==
+  data.tar.gz: !binary |-
+    YTY0ODMzZTY0ZWYxODhmMzMwYWYyNDI1MTIzMjVhNGRiNzhjMjZhZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjVhYTAwNGJmZmU1ZmIxNDE0YTdiZGQ5YjBiOWYxODRiNWE5MWQ1OWE4M2Y0
+    ZDVmYmM2NDFiMGExYzI4ODg2NTI4OWFhZWI1YjZmNWEzODA5NDYwZmMzMWZk
+    ZmM4YTc5OTIxOTNiMDI2ZjU0N2UwNDdkMDZmNTZlODNkM2E3YjM=
+  data.tar.gz: !binary |-
+    YzBiM2ZlMjJmOGM5ODMxMGQ5ZGUzOGNhYzA1NmI0MzEzNjQxYjA3NmFhZjAx
+    ZDRkNzM4NWY3YWIzMDk4OTk0OWVjZWM2NTBhY2Y5YjE2NzMwOGU3ZjA3NjM5
+    ZmZjZjU5YTE1NmQ1Yzg5NWQ5ZGE5YjlkNDAzMTNjNDI0MzRlMDI=

data/.gitignore

@@ -0,0 +1,2 @@
+.idea/
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    grape-hal (0.0.1)
+      grape
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    axiom-types (0.0.5)
+      descendants_tracker (~> 0.0.1)
+      ice_nine (~> 0.9)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    columnize (0.3.6)
+    debugger (1.6.4)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.0)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    equalizer (0.0.9)
+    grape (0.6.1)
+      activesupport
+      builder
+      hashie (>= 1.2.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    hashie (2.0.5)
+    i18n (0.6.9)
+    ice_nine (0.11.0)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.7)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+    virtus (1.0.1)
+      axiom-types (~> 0.0.5)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0.1)
+      equalizer (~> 0.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  grape-hal!
+  pry
+  pry-debugger
+  rack-test
+  rake (~> 10.0.4)
+  rspec

data/README.md

@@ -0,0 +1,98 @@
+Grape Hal
+=========
+
+Description
+-----------
+
+A ruby gem which adds HAL support to ruby Grape Api.
+
+HAL
+---
+
+HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API. See [HAL (Hyperlink Application Language)](http://stateless.co/hal_specification.html)
+
+Ruby Grape
+----------
+
+github: [ruby grape api](https://github.com/intridea/grape)
+
+Installation
+------------
+
+Install the gem by:
+
+    gem install grape-hal
+
+Or add the gem to your Gemfile
+
+    gem 'grape-hal'
+
+Examples
+--------
+
+If you want to add Hal response to your exist Grape Api, just simply include `Grape::Hal` and then use the dsl to describe your Apis.
+
+Here are some Grape Apis. Note the `include Grape::Hal` and `hal_for` block.
+
+```ruby
+class FooApi < ::Grape::API
+  desc 'foo api description', rel: 'foo api'
+  get '/foo_path/'
+end
+
+class SubApi < ::Grape::API
+  desc 'bar api description with {param}', rel: 'bar api'
+  get 'bar_path/:param'
+
+  desc 'qux api description', rel: 'qux api'
+  get 'qux_path'
+end
+
+class BazApi < ::Grape::API
+
+  include Grape::Hal
+
+  mount FooApi
+  mount SubApi
+
+  hal_for '/' do
+    hal_for '/sub', rel: 'sub', title: 'a sub api module' do
+      mount SubApi
+    end
+    mount FooApi
+  end
+
+end
+```
+
+After this, when a http request to specific path with `json` format accept headers.
+
+    GET / HTTP/1.1
+    Accept: application/hal+json, application/json, */*; q=0.01
+
+`grape/hal` will response with the Hal data for you.
+
+    HTTP/1.1 200 OK
+    Content-Type: application/hal+json
+
+    {
+      "_links": {
+        "self": {
+          "href": "/"
+        },
+        "sub": {
+          "href": "/sub",
+          "title": "a sub api module"
+        },
+        "foo api": {
+          "href": "/foo_path",
+          "title": "foo api description"
+        }
+      }
+    }
+
+Footer
+------
+
+Feng Zhichao flankerfc(at)gmail.com
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => [:spec]

data/grape-hal.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-hal'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Feng Zhichao']
+  spec.email         = %w(flankerfc@gmail.com)
+  spec.description   = %q{Provides the HAL response for Grape API application}
+  spec.summary       = %q{HAL support for your Grape app}
+  spec.homepage      = 'https://github.com/flanker/grape-hal'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0.4'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-debugger'
+
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'grape'
+end

data/lib/grape/hal.rb

@@ -0,0 +1,13 @@
+require 'grape'
+require 'grape/hal/dsl'
+require 'grape/hal/endpoint'
+
+module Grape
+  module Hal
+
+    def self.included(base)
+      base.extend(Dsl)
+    end
+
+  end
+end

data/lib/grape/hal/dsl.rb

@@ -0,0 +1,20 @@
+module Grape
+  module Hal
+    module Dsl
+
+      def hal_for(context_path, &block)
+        content_type :json, 'application/hal+json'
+
+        endpoint = Endpoint.new self, context_path
+        endpoint.instance_eval(&block)
+
+        get context_path do
+          base_url = env['PATH_INFO']
+          content_type 'application/hal+json'
+          endpoint.generate_hal base_url
+        end
+      end
+
+    end
+  end
+end

data/lib/grape/hal/endpoint.rb

@@ -0,0 +1,87 @@
+module Grape
+  module Hal
+    class Endpoint
+
+      include Dsl
+
+      attr_reader :entries, :context_path, :current_api
+
+      def initialize(current_api, context_path)
+        @current_api = current_api
+        @context_path = context_path
+        @entries = []
+        add_self
+      end
+
+      def hal_for(path, options = {}, &block)
+        entries << {
+            path: path,
+            rel: options[:rel],
+            title: options[:title]
+        }
+        current_api.hal_for path, &block
+      end
+
+      def mount(api)
+        api.endpoints.each do |endpoint|
+          options = endpoint.options
+          options[:path].each do |path|
+            entries << {
+                path: path,
+                rel: options[:route_options][:rel],
+                title: options[:route_options][:description]
+            }
+          end
+        end
+      end
+
+      def generate_hal(base_path)
+        hal_array = entries.map do |entry|
+          key = entry[:rel] || entry[:path]
+
+          value = {href: get_full_path(base_path, entry)}
+          value[:title] = entry[:title] if entry[:title]
+          value[:templated] = true if is_templated?(entry)
+          [key, value]
+        end
+        {:_links => Hash[hal_array]}
+      end
+
+      private
+
+      def add_self
+        self_entry = {
+            path: '',
+            rel: 'self'
+        }
+        entries << self_entry
+      end
+
+      def get_full_path(base_path, entry)
+        base_path = remove_parent_context_path(base_path) unless entry[:rel] === 'self'
+        handle_path = parameterize(entry)
+        File.join(base_path + handle_path)
+      end
+
+      def parameterize(entry)
+        entry[:path].split('/').map do |segment|
+          segment = '{' + segment[1..-1] + '}' if segment.start_with?(':')
+          segment
+        end.join('/')
+      end
+
+      def remove_parent_context_path(base_path)
+        if base_path.end_with?(context_path)
+          slice_to = base_path.rindex(context_path)
+          base_path = base_path.slice(0, slice_to)
+        end
+        base_path
+      end
+
+      def is_templated?(entry)
+        entry[:path].split('/').any? { |s| s.start_with?(':') }
+      end
+
+    end
+  end
+end

data/spec/integration_tests/hal_for_grape_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module IntegrationTests
+
+  class FooApi < ::Grape::API
+    desc 'foo api description', rel: 'foo api'
+    get '/foo_path/'
+  end
+
+  class SubApi < ::Grape::API
+    desc 'bar api description with {param}', rel: 'bar api'
+    get 'bar_path/:param'
+
+    desc 'qux api description', rel: 'qux api'
+    get 'qux_path'
+  end
+
+  class BazApi < ::Grape::API
+
+    after do
+      header 'Access-Control-Allow-Origin', '*'
+    end
+
+    include Grape::Hal
+
+    mount FooApi
+    mount SubApi
+
+    hal_for '/' do
+      hal_for '/sub', rel: 'sub', title: 'a sub api module' do
+        mount SubApi
+      end
+      mount FooApi
+    end
+
+  end
+
+  describe 'Hal for grape' do
+
+    include Rack::Test::Methods
+
+    def app
+      Rack::Builder.new do
+        run BazApi
+      end
+    end
+
+    describe 'root path' do
+
+      subject {
+        response = get '/', :format => 'json'
+        JSON.parse(response.body)['_links']
+      }
+
+      it { should == {
+          'self' => {
+              'href' => '/'
+          },
+          'sub' => {
+              'href' => '/sub',
+              'title' => 'a sub api module'
+          },
+          'foo api' => {
+              'href' => '/foo_path',
+              'title' => 'foo api description'
+          }
+      }}
+
+    end
+
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rack'
+require 'rack/test'
+require 'json'
+
+require 'grape/hal'

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: grape-hal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Feng Zhichao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: grape
+  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: Provides the HAL response for Grape API application
+email:
+- flankerfc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- grape-hal.gemspec
+- lib/grape/hal.rb
+- lib/grape/hal/dsl.rb
+- lib/grape/hal/endpoint.rb
+- spec/integration_tests/hal_for_grape_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flanker/grape-hal
+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.0.14
+signing_key: 
+specification_version: 4
+summary: HAL support for your Grape app
+test_files:
+- spec/integration_tests/hal_for_grape_spec.rb
+- spec/spec_helper.rb