restful_resource 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e007325204f8aa0dfb465f3370a0d2e84f54a94
+  data.tar.gz: c23007a5a0a3e8320fda92f43ed0a2290c0c3b65
+SHA512:
+  metadata.gz: 6f6abda88019ec8739f80b92aaab7c4a3b014689caf050b92ddc58ab9ef61b5da5c7eca24012917e39986d57cd1e667675c6598c85fe6b7730e12dcff7ee76cd
+  data.tar.gz: 41eee9a852ea62125c0c44d6264a4d3817ac35304850bb9c1cb66cc66e8db85b234bbe9d800909003c54fd2b1593bbe20b44ebf1a61f2c28ff63b9eb4ca52cf3

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Santoro
+
+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,29 @@
+# RestfulResource
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'restful_resource'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restful_resource
+
+## 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

data/Rakefile

@@ -0,0 +1,44 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Upload to rubygems"
+task :upload => :build do
+  # Check if tag with v#{ResearchSiteApiClient::VERSION} version exists, if so, return with error
+
+  if tag_exists?(current_tag_name)
+    puts "Tag exists, did you run rake increase_revision_number after merging with master?"
+    exit 1
+  end
+
+  create_tag(current_tag_name)
+  Rake::Task[:release].invoke
+end
+
+desc "Increase the revision number"
+task :increase_revision_number do
+  version_file = "lib/restful_resource/version.rb"
+  file_content = File.read(version_file)
+  rule = /(\d+\.\d+\.)(\d+)/
+  new_revision_number = rule.match(file_content)[2].to_i + 1
+  new_file_content = file_content.sub(rule, '\1' + new_revision_number.to_s)
+
+  File.open(version_file, 'w') { |file| file.write(new_file_content) }
+end
+
+def tag_exists?(tag_name)
+  result = `git tag | grep #{tag_name}`.strip
+  result == tag_name
+end
+
+def create_tag(tag_name)
+  sh "git tag -a #{tag_name} -m \"Released version #{tag_name}\""
+  sh "git push origin #{tag_name}"
+end
+
+def current_tag_name
+  "v#{RestfulResource::VERSION}"
+end

data/lib/restful_resource/base.rb

@@ -0,0 +1,137 @@
+module RestfulResource
+  class Base
+    def self.url=(url)
+      @url = url
+    end
+
+    def self.url(params={})
+      url = @url
+      params.keys.each do |key|
+        url = url.gsub(':'+key.to_s, params[key].to_s)
+      end
+
+      url_params = url.scan(/:([^\/]+)/)
+      if url_params.any?
+        raise ParameterMissingError.new(url_params)
+      end
+
+      url
+    end
+
+    def self.has_one(nested_resource_type)
+      klass = nested_resource_type.to_s.camelize.safe_constantize
+      klass = OpenStruct if (klass.nil? || klass.superclass != RestResource)
+
+      self.send(:define_method, nested_resource_type) do
+        nested_resource = @inner_object.send(nested_resource_type)
+        return nil if nested_resource.nil?
+        klass.new(@inner_object.send(nested_resource_type))
+      end
+    end
+
+    def self.has_many(nested_resource_type)
+      klass = nested_resource_type.to_s.singularize.camelize.safe_constantize
+      klass = OpenStruct if (klass.nil? || (klass.superclass != RestResource))
+
+      self.send(:define_method, nested_resource_type) do
+        @inner_object.send(nested_resource_type).map { |obj| klass.new(obj) }
+      end
+    end
+
+    def initialize(attributes = {}, hack_for_activeresource = false)
+      @inner_object = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      @inner_object.send(method, *args, &block)
+    end
+
+    def valid?
+      errors.nil? || errors.count == g
+    end
+
+    def self.find(id, url_params={})
+      response = RestClient.get("#{url(url_params)}/#{id}", params: {})
+      self.new(ActiveSupport::JSON.decode(response))
+    end
+
+    def self.update_attributes(id, attributes)
+      begin
+        result = parse(RestClient.put("#{url}/#{id}", attributes))
+      rescue RestClient::UnprocessableEntity => e
+        errors = parse(e.response)
+        result = attributes.merge(errors: errors)
+      end
+      self.new(result)
+    end
+
+    def self.create(attributes)
+      begin
+        result = parse(RestClient.post("#{url}", attributes))
+      rescue RestClient::UnprocessableEntity => e
+        errors = parse(e.response)
+        result = attributes.merge(errors: errors)
+      end
+      self.new(result)
+    end
+
+    def self.search(params = {})
+      response = RestClient.get("#{url}/search", params: params)
+      paginate_response(response)
+    end
+
+    def self.all(params = {})
+      response = RestClient.get("#{url}", params: params)
+      paginate_response(response)
+    end
+
+    def self.get(postfix_url = "", params = {})
+      response = RestClient.get("#{url}#{postfix_url}", params: params)
+      paginate_response(response)
+    end
+
+    def self.put(postfix_url = "", params = {})
+      response = RestClient.put("#{url}#{postfix_url}", params)
+    end
+
+    def self.post(postfix_url = "", params = {})
+      response = RestClient.post("#{url}#{postfix_url}", params)
+    end
+
+    def self.all_not_paginated
+      page = 1
+      results = []
+      while page
+        page_data = self.all(page: page);
+        results += page_data
+        page = page_data.next_page
+      end
+
+      results
+    end
+
+    def self.parse(json)
+      ActiveSupport::JSON.decode(json)
+    end
+
+    def to_json(*args)
+      @inner_object.send(:table).to_json(*args)
+    end
+
+    def as_json(*)
+      @inner_object.send(:table).as_json
+    end
+
+    private
+    def self.paginate_response(response)
+      links_header =  response.headers[:links]
+      links = LinkHeader.parse(links_header)
+
+      prev_url = links.find_link(['rel', 'prev']).try(:href)
+      next_url = links.find_link(['rel', 'next']).try(:href)
+
+      array = ActiveSupport::JSON.decode(response).map { |attributes| self.new(attributes) }
+      PaginatedArray.new(array, previous_page_url: prev_url, next_page_url: next_url)
+    end
+  end
+end

data/lib/restful_resource/paginated_array.rb

@@ -0,0 +1,25 @@
+module RestfulResource
+  class PaginatedArray < Array
+    def initialize(original_array, previous_page_url: previous_page_url, next_page_url: next_page_url)
+      super(original_array)
+
+      @previous_page_url = previous_page_url
+      @next_page_url = next_page_url
+    end
+
+    def previous_page
+      get_page_from_url(@previous_page_url)
+    end
+
+    def next_page
+      get_page_from_url(@next_page_url)
+    end
+
+    private
+    def get_page_from_url(url)
+      return nil unless url
+      params = Rack::Utils.parse_query URI(url).query
+      params['page'].to_i
+    end
+  end
+end

data/lib/restful_resource/parameter_missing_error.rb

@@ -0,0 +1,11 @@
+module RestfulResource
+  class ParameterMissingError < StandardError
+    def initialize(missing_parameters)
+      @missing_parameters = missing_parameters
+    end
+
+    def message
+      "You must pass values for the following parameters: [#{@missing_parameters.join(', ')}]"
+    end
+  end
+end

data/lib/restful_resource/version.rb

@@ -0,0 +1,3 @@
+module RestfulResource
+  VERSION = "0.0.5"
+end

data/lib/restful_resource.rb

@@ -0,0 +1,10 @@
+require 'rack'
+require 'link_header'
+require 'restclient'
+require 'active_support'
+require 'active_support/all'
+require "restful_resource/version"
+require "restful_resource/paginated_array"
+require "restful_resource/parameter_missing_error"
+require "restful_resource/base"
+

data/restful_resource.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restful_resource/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restful_resource"
+  spec.version       = RestfulResource::VERSION
+  spec.authors       = ["David Santoro"]
+  spec.email         = ["developers@carwow.co.uk"]
+  spec.description   = %q{A simple activerecord inspired rest resource base class implemented using rest-client}
+  spec.summary       = %q{A simple activerecord inspired rest resource base class implemented using rest-client}
+  spec.homepage      = "http://www.github.com/carwow/restful_resource"
+  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"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "link_header"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "rack"
+end

data/spec/restful_resource/base_spec.rb

@@ -0,0 +1,89 @@
+require_relative '../spec_helper'
+
+describe RestfulResource::Base do
+  context "#find" do
+    it "should retrieve a resource with a simple url" do
+      response = { id: 15, name: 'Arsenal' }.to_json 
+      stub_get('http://api.carwow.co.uk/teams/15', response)
+      
+      team = Team.find(15)
+
+      expect(team.id).to eq 15
+      expect(team.name).to eq 'Arsenal'
+    end
+
+    it "should retrieve a nested resource" do
+      response = { id: 1, team_id: 15, name: 'David', santoro: 'Santoro' }.to_json 
+      stub_get('http://api.carwow.co.uk/teams/15/players/1', response)
+
+      player = Player.find(1, team_id: 15)
+      
+      expect(player.id).to eq 1
+      expect(player.team_id).to eq 15
+      expect(player.name).to eq 'David'
+    end
+  end
+
+  context "#url" do
+    it "should return the url set if no extra parameters are necessary" do
+      Player.url = 'http://api.carwow.co.uk/players'
+
+      expect(Player.url).to eq 'http://api.carwow.co.uk/players'
+    end
+
+    it "should return the url with the right parameters replaced" do
+      Player.url = 'http://api.carwow.co.uk/teams/:team_id/players'
+
+      expect(Player.url(team_id: 13)).to eq 'http://api.carwow.co.uk/teams/13/players'
+    end
+
+    it "should raise a parameter required exception if parameter needed and not provided" do
+      Player.url = 'http://api.carwow.co.uk/countries/:country_slug/teams/:team_id/players'
+
+      expected_error_message = 'You must pass values for the following parameters: [country_slug, team_id]'
+      expect { Player.url }.to raise_error(RestfulResource::ParameterMissingError, expected_error_message)
+    end
+  end
+
+  context "#all" do
+    it "should provide a paginated result if response contains rest pagination headers" do
+      response = [{ id: 1, name: 'Arsenal'}, { id: 2, name: 'Chelsea' }].to_json 
+      allow(response).to receive(:headers) { 
+        {:links => '<http://api.carwow.co.uk/teams.json?page=6>;rel="last",<http://api.carwow.co.uk/teams.json?page=2>;rel="next"'}
+      }
+      stub_get('http://api.carwow.co.uk/teams', response)
+
+      teams = Team.all
+
+      expect(teams.previous_page).to be_nil
+      expect(teams.next_page).to eq 2
+      expect(teams.first.name).to eq 'Arsenal'
+      expect(teams.last.name).to eq 'Chelsea'
+    end
+  end
+
+  it "should act as an openstruct" do
+    example = Player.new(name: 'David', surname: 'Santoro')
+
+    expect(example.name).to eq 'David'
+    expect(example.surname).to eq 'Santoro'
+  end
+
+  private
+  def stub_get(url, fake_response, params = {})
+    expect(RestClient).to receive(:get).
+                          with(url, params: params).
+                          and_return(fake_response)
+  end
+end
+
+class Team < RestfulResource::Base
+  self.url = "http://api.carwow.co.uk/teams"
+end
+
+class Player < RestfulResource::Base
+  self.url = "http://api.carwow.co.uk/teams/:team_id/players"
+end
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require_relative '../lib/restful_resource'
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :progress 
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: restful_resource
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- David Santoro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-06 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: link_header
+  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: activesupport
+  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: 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'
+description: A simple activerecord inspired rest resource base class implemented using
+  rest-client
+email:
+- developers@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/restful_resource.rb
+- lib/restful_resource/base.rb
+- lib/restful_resource/paginated_array.rb
+- lib/restful_resource/parameter_missing_error.rb
+- lib/restful_resource/version.rb
+- restful_resource.gemspec
+- spec/restful_resource/base_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/carwow/restful_resource
+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: A simple activerecord inspired rest resource base class implemented using
+  rest-client
+test_files:
+- spec/restful_resource/base_spec.rb
+- spec/spec_helper.rb