hypermedia_mapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14fdbced901fa6c4a88c618a604b8e9290d729b7
+  data.tar.gz: 371bdd6c6150e3104cf6f59724d13f0dfce97dcb
+SHA512:
+  metadata.gz: 57660927b6560b5dd0fa6730208ab2ecff180210a977feba69c984ab815fcec31115426ea83ed0eed9807153ceb3873a31b57504791dbcf836f216536a3de4ef
+  data.tar.gz: 8b6cda896345b2ba4996eb973434c97afc64bb38a7c95487c5137ea260a89e94c413a4c97ac9dd25fc565aa8ba42f48fa1b7a9374a4e1690975c1fd99bf56fcf

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hypermedia_mapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Redu Educational Technologies
+
+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,43 @@
+# HypermediaMapper
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hypermedia_mapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hypermedia_mapper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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
+
+<img src="https://github.com/downloads/redu/redupy/redutech-marca.png" alt="Redu Educational Technologies" width="300">
+
+This project is maintained and funded by [Redu Educational Techologies](http://tech.redu.com.br).
+
+# Copyright
+
+Copyright (c) 2012 Redu Educational Technologies
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hypermedia_mapper.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hypermedia_mapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hypermedia_mapper"
+  spec.version       = HypermediaMapper::VERSION
+  spec.authors       = ["Juliana Lucena", "Guilherme Cavalcanti", "Tiago Ferreira"]
+  spec.email         = ["julianalucenaa@gmail.com", "guiocavalcanti@gmail.com", "fltiago@gmail.com"]
+  spec.description   = %q{Hypermedia Mapper}
+  spec.summary       = %q{Hypermedia Mapper}
+  spec.homepage      = "http://github.com/redu/hypermedia_mapper"
+  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 'rspec', '~> 2.14.rc1'
+
+  spec.add_runtime_dependency 'virtus', '~> 0.5.4'
+end

data/lib/hypermedia_mapper.rb

@@ -0,0 +1,10 @@
+require 'virtus'
+
+require "hypermedia_mapper/version"
+require 'hypermedia_mapper/link'
+require 'hypermedia_mapper/link_parser'
+require 'hypermedia_mapper/link_collection'
+
+module HypermediaMapper
+  # Your code goes here...
+end

data/lib/hypermedia_mapper/link.rb

@@ -0,0 +1,14 @@
+module HypermediaMapper
+  class Link
+    include Virtus
+
+    attribute :href, String
+    attribute :rel, String
+
+    alias_method :relationship, :rel
+
+    def ==(other)
+      self.href == other.href && self.rel == other.rel
+    end
+  end
+end

data/lib/hypermedia_mapper/link_collection.rb

@@ -0,0 +1,28 @@
+module HypermediaMapper
+  class LinkCollection
+    include Enumerable
+
+    def initialize(options={})
+      @raw_links = options[:items]
+      @parser_class = options[:parser] || LinkParser
+    end
+
+    def fetch(relationship)
+      find { |i| i.rel == relationship.to_s }
+    end
+
+    def each(&block)
+      items.each(&block)
+    end
+
+    private
+
+    def parser_builder
+      @parser ||= @parser_class.new(@raw_links)
+    end
+
+    def items
+      @items ||= parser_builder.parse
+    end
+  end
+end

data/lib/hypermedia_mapper/link_parser.rb

@@ -0,0 +1,11 @@
+module HypermediaMapper
+  class LinkParser
+    def initialize(links)
+      @raw_links = links
+    end
+
+    def parse
+      @parsed_links ||= @raw_links.map { |link| Link.new(link) }
+    end
+  end
+end

data/lib/hypermedia_mapper/version.rb

@@ -0,0 +1,3 @@
+module HypermediaMapper
+  VERSION = "0.0.1"
+end

data/spec/link_collection_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module HypermediaMapper
+  describe LinkCollection do
+    let(:links) do
+      [
+        { "rel" => "self",
+          "href" => "http://www.redu.com.br/api/subjects/4723" },
+        { "rel" => "lectures",
+          "href" => "http://www.redu.com.br/api/subjects/4723/lectures" },
+        { "rel" => "space",
+          "href" => "http://www.redu.com.br/api/courses/2231" },
+        { "rel" => "course",
+          "href" => "http://www.redu.com.br/api/courses/exemplo-de-aplicativos" },
+      ]
+    end
+
+    let(:parser) { LinkParser }
+    subject { LinkCollection.new(items: links) }
+
+    it "should fetch the request relationship" do
+      expect(subject.fetch(:space).href).to eq links[2]["href"]
+    end
+
+    it "should return nil if the link don't exist" do
+      expect(subject.fetch(:environment)).to be_nil
+    end
+
+    it "should return a link" do
+      expect(subject.fetch(:space)).to be_a Link
+    end
+
+    it "should be a enumerable" do
+      expect(subject).to be_a Enumerable
+      expect(subject).to respond_to(:each)
+    end
+  end
+end

data/spec/link_parser_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module HypermediaMapper
+  describe LinkParser do
+    let(:links) do
+      [
+        { "rel" => "self", "href" => "http://www.redu.com.br/api/subjects/4723" },
+        { "rel" => "lectures", "href" => "http://www.redu.com.br/api/subjects/4723/lectures" },
+        { "rel" => "space", "href" => "http://www.redu.com.br/api/courses/2231" },
+        { "rel" => "course", "href" => "http://www.redu.com.br/api/courses/exemplo-de-aplicativos" },
+      ]
+    end
+
+    subject { LinkParser.new(links) }
+
+    it "should parse the links" do
+      expect(subject.parse).to eq links.map { |l| Link.new(l) }
+    end
+
+    it "should avoid iterating over the links" do
+      subject.parse
+      expect(links).to_not receive(:map)
+      subject.parse
+    end
+  end
+end

data/spec/link_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module HypermediaMapper
+  describe Link do
+    let(:link) do
+      { "rel" => "space", "href" => "http://www.redu.com.br/api/courses/2231" }
+    end
+    subject { Link.new(link) }
+
+    it "should return the href" do
+      expect(subject.href).to eq link["href"]
+    end
+
+    it "should return the relationship" do
+      expect(subject.relationship).to eq link["rel"]
+    end
+
+    it "should alias #rel to #relationship" do
+      expect(subject.rel).to eq subject.relationship
+    end
+
+    context "==" do
+      it "should return true when the objects have the same rel and href" do
+        expect(subject).to eq Link.new(link)
+      end
+
+      it "should return false otherwise" do
+        expect(subject).to_not eq Link.new({})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'hypermedia_mapper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: hypermedia_mapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Juliana Lucena
+- Guilherme Cavalcanti
+- Tiago Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.rc1
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+description: Hypermedia Mapper
+email:
+- julianalucenaa@gmail.com
+- guiocavalcanti@gmail.com
+- fltiago@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hypermedia_mapper.gemspec
+- lib/hypermedia_mapper.rb
+- lib/hypermedia_mapper/link.rb
+- lib/hypermedia_mapper/link_collection.rb
+- lib/hypermedia_mapper/link_parser.rb
+- lib/hypermedia_mapper/version.rb
+- spec/link_collection_spec.rb
+- spec/link_parser_spec.rb
+- spec/link_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/redu/hypermedia_mapper
+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: Hypermedia Mapper
+test_files:
+- spec/link_collection_spec.rb
+- spec/link_parser_spec.rb
+- spec/link_spec.rb
+- spec/spec_helper.rb