api-extensions 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjYxMWQxNDgwYmY0YjJmMDY5OGZhMWZkNzdhNmM0NjkwODAzNzZjMg==
+  data.tar.gz: !binary |-
+    YzViOWVhNGRkMjljMGI5ODhhZGU1ZjVhMTMwNmNlYWZmOTRhM2RkZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjA0NDk1M2VkMGI0YmE4MzFkY2RlYTQzN2IzZWRhNjljNzkxYThmNzgzODBi
+    MWMyOWIwYzBjMzhmYjRjMzIwZWQ5MGMyMDU4ZTdhODJkMDc4ZjQ4MTgyZjVj
+    YjNjZDIwMjg5ZTc1NjM2MDUzZDQxMWUyNzBmMzU2ZjhkMGQyYmU=
+  data.tar.gz: !binary |-
+    ZDYxZDQxMWFkODg0NzEwZjI1NmY0NzYzMjllNjBlOTAxNDAxN2UzMDkzMjhl
+    NGI0ZjE2NzA1NGY4MmExMDNlYTJjOWM0NWY0NTdhMTg2ZTU5OWUyZWM3ZjIz
+    NDBjNmRjODdmZGZhZmU3ZDY3YTIwMDU3YjRhZGI3MWJkYWQ2NGM=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nahuel Cuesta Luengo
+
+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,54 @@
+# api-extensions [![Build Status](https://travis-ci.org/ncuesta/api-extensions.png)](https://travis-ci.org/ncuesta/api-extensions) [![Dependency Status](https://gemnasium.com/ncuesta/api-extensions.png)](https://gemnasium.com/ncuesta/api-extensions) [![Code Climate](https://codeclimate.com/github/ncuesta/api-extensions.png)](https://codeclimate.com/github/ncuesta/api-extensions)
+
+A collection of extensions for Hypermedia-driven APIs following the standard definitions
+at [the api-doc repo](https://github.com/ncuesta/api-doc).
+
+Included extensions:
+
+- `fields`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api-extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-extensions
+
+## Usage
+
+### `fields` extension
+
+The behavior of this extension is best described at
+[the api-doc repo](https://github.com/ncuesta/api-doc/blob/master/README.en.md#partial-responses).
+
+By including the `Api::Extensions::Fields` module in any class, you will get a `process_fields`
+method that will handle the creation of partial responses - as described in the linked document.
+
+```ruby
+require 'api/extensions/fields'
+
+class MyApiHandler
+  include Api::Extensions::Fields
+
+  def handle(request)
+    response = fiddle_with request
+    process_fields request[:fields], response, request.path
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.profile = 'default'
+end
+
+Cucumber::Rake::Task.new(:"features:html", 'Run Cucumber features and produce HTML output') do |t|
+  t.profile = 'html_report'
+end
+
+task default: :features

data/api-extensions.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'api/extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'api-extensions'
+  spec.version       = Api::Extensions::VERSION
+  spec.authors       = ['Nahuel Cuesta Luengo']
+  spec.email         = ['nahuelcuestaluengo@gmail.com']
+  spec.description   = %q{Extensions for Hypermedia-driven APIs}
+  spec.summary       = %q{A collection of extensions for Hypermedia-driven APIs}
+  spec.homepage      = 'https://github.com/ncuesta/api-extensions'
+  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 = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'cucumber'
+
+  spec.add_dependency 'json', '~> 1.8.0'
+end

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --format pretty
+html_report: --format progress --format html --out=features_report.html

data/features/fields.feature

@@ -0,0 +1,40 @@
+Feature: Fields functional extension
+  In order to reduce the size of an API response
+  As a client application
+  I want to be able to specify which fields I need
+
+  Scenario Outline: Empty or invalid values
+    Given I get a request for resource "/articles/1.json"
+    And I get the fields parameter "<value>"
+    When I process the fields parameter
+    Then the resulting response should be the same as the original one
+
+    Examples:
+      | value |
+      |       |
+      | ,     |
+      | ,,    |
+      | ,,,   |
+      | ,,,,  |
+      | ,,,,, |
+
+
+  Scenario Outline: Specify partial responses
+    Given I get a request for resource "/articles/1.json"
+    And I get the fields parameter "<value>"
+    When I process the fields parameter
+    Then the resulting response should include the required fields
+    And the resulting response should only contain "<specific_non_required_fields>" as non-required fields
+
+    Examples:
+      | value                         | specific_non_required_fields |
+      | title                         | title                        |
+      | title,name                    | title,name                   |
+      | title,name,                   | title,name                   |
+      | title,name,non_existent_field | title,name                   |
+
+  Scenario: A link to the full resource is added to partial responses
+    Given I get a request for resource "/articles/1.json"
+    And I get the fields parameter "title,name"
+    When I process the fields parameter
+    Then the resulting response should include a link to the full resource

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,22 @@
+def resources
+  {
+    '/articles/1.json' => {
+      'id' => 1,
+      'title' => 'Title',
+      'name' => 'Name',
+      'number' => 9,
+      'child' => {
+        'nested' => true
+      },
+      'links' => {
+        'self' => { 'href' => '/link/to/self' },
+        'other' => { 'href' => '/link/to/other' }
+      }
+    }
+  }
+end
+
+Given /^I get a request for resource "(.*)"$/ do |resource|
+  @request_path = resource
+  @response = resources[resource]
+end

data/features/step_definitions/fields_steps.rb

@@ -0,0 +1,49 @@
+require 'api/extensions/fields'
+
+Before do
+  @processor = Object.new
+  class << @processor
+    include(Api::Extensions::Fields)
+  end
+end
+
+def required_fields
+  %w(links)
+end
+
+
+Given /^I get the fields parameter "(.*)"$/ do |value|
+  @fields = value
+end
+
+When /^I process the fields parameter$/ do
+  @result = @processor.process_fields @fields, @response, @request_path
+end
+
+Then /^the resulting response should include the required fields$/ do
+  required_fields.each do |field|
+    assert_include @result, field, "The field #{field} is not included"
+  end
+end
+
+Then /^the resulting response should (contain|not contain) all the non-required fields$/ do |contain|
+  assert_equal @response.keys, @result.keys, 'At least one non-required field is missing' if contain == 'contain'
+end
+
+Then /^the resulting response should only contain "(.*)" as non-required fields$/ do |specific_fields|
+  specific_fields = specific_fields.split ','
+
+  if specific_fields.length > 0
+    keys = @result.keys - required_fields
+    assert keys.reject { |k| keys.include? k }.empty?, 'Some extra keys were found but not expected'
+  end
+end
+
+Then(/^the resulting response should be the same as the original one$/) do
+  assert_equal @response, @result, 'The response has changed'
+end
+
+Then(/^the resulting response should include a link to the full resource$/) do
+  assert @response['links'].has_key?('full'), 'The response lacks a "full" link'
+  assert_equal @request_path, @response['links']['full']['href'], 'The "full" link is wrong'
+end

data/lib/api/extensions/fields.rb

@@ -0,0 +1,30 @@
+#
+# Fields extension
+#
+# https://github.com/ncuesta/api-doc/blob/master/README.en.md#partial-responses
+#
+module Api
+  module Extensions
+    module Fields
+      # Process the fields functional extension
+      def process_fields(keys, response, full_link = nil)
+        fields = parse_fields keys
+        response.reject! { |k, v| !fields.include? k } if fields.length > 0
+        response['links']['full'] = { 'href' => full_link } unless full_link.nil?
+
+        response
+      end
+
+      # Parse a string for the fields functional extension
+      #   - Add the required fields if not present
+      def parse_fields(fields_string)
+        required_fields + fields_string.split(',')
+      end
+
+      # Get the required fields for any response
+      def required_fields
+        ['links']
+      end
+    end
+  end
+end

data/lib/api/extensions/version.rb

@@ -0,0 +1,5 @@
+module Api
+  module Extensions
+    VERSION = '0.0.1'
+  end
+end

data/lib/api/extensions.rb

@@ -0,0 +1,7 @@
+require 'api/extensions/fields'
+require 'api/extensions/version'
+
+module Api
+  module Extensions
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: api-extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nahuel Cuesta Luengo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-29 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Extensions for Hypermedia-driven APIs
+email:
+- nahuelcuestaluengo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-extensions.gemspec
+- cucumber.yml
+- features/fields.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/fields_steps.rb
+- lib/api/extensions.rb
+- lib/api/extensions/fields.rb
+- lib/api/extensions/version.rb
+homepage: https://github.com/ncuesta/api-extensions
+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.3
+signing_key: 
+specification_version: 4
+summary: A collection of extensions for Hypermedia-driven APIs
+test_files:
+- features/fields.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/fields_steps.rb