activeresource_headers 0.0.1

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
+*.swp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  
+script: bundle exec rspec
+
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Denis Yagofarov
+
+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,53 @@
+[![Build Status](https://secure.travis-ci.org/denyago/activeresource_headers.png)](http://travis-ci.org/denyago/activeresource_headers)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/denyago/activeresource_headers)
+
+# Activeresource Headers
+
+Add ability to send custom headers on each http request by an ActiveResource model.
+
+There are two ways of setting headers.
+  * class method ```custom_headers do ... end``` in a model, that is an ActiveResource::Base kind
+  * chainable method ```with_headers```, that can be putten between model class and ```find``` method
+
+## Examples
+
+```ruby
+
+  class Person < ActiveResource::Base
+    include ActiveresourceHeaders::CustomHeaders
+
+    self.site = 'http://example.com'
+
+    custom_headers do
+      {"My-Time" => Time.now.to_s}
+    end
+  end
+
+  Person.find(:all) #=> will add header "My-Time: 2012-10-02 18:56:18 +0300"
+
+  Person.with_headers("My-Time" => "to drink!", "Age" => "25+").find(:all)
+    #=> will add headers "My-Time: to drink!" and "Age: 25+"
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activeresource_headers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeresource_headers
+
+## 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 @@
+require "bundler/gem_tasks"

data/activeresource_headers.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activeresource_headers/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "activeresource_headers"
+  gem.version       = ActiveresourceHeaders::VERSION
+  gem.authors       = ["Denis Yagofarov"]
+  gem.email         = ["denyago@gmail.com"]
+  gem.description   = %q{Send custom headers with ActiveResource requests}
+  gem.summary       = %q{Adds custom_headers { ... } method to ActiveResource model. Those headers merged to deafult ones, each time AR requests api.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  rails_version = "~> 3.2"
+
+  gem.add_dependency  'activeresource', rails_version
+
+  gem.add_development_dependency 'rspec',             '~> 2.11'
+  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'activesupport',     rails_version
+
+end

data/lib/activeresource_headers.rb

@@ -0,0 +1,5 @@
+require "activeresource_headers/version"
+require "activeresource_headers/custom_headers"
+
+module ActiveresourceHeaders
+end

data/lib/activeresource_headers/custom_headers.rb

@@ -0,0 +1,62 @@
+require 'active_support/concern'
+require 'active_support/core_ext/hash/deep_merge'
+
+module ActiveresourceHeaders
+  ##
+  # When included to #ActiveResource::Base model,
+  # adds mthods to set additional headers for http
+  # requests.
+  module CustomHeaders
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Sets block to execute each time. Block must
+      # respond to #call and return #Hash each time.
+      def custom_headers(&block)
+        @custom_headers = block
+      end
+
+      # Saves headers #Hash for use in <i>current</i> request.
+      def with_headers(headers={})
+        @with_headers = headers
+        self
+      end
+
+    protected
+
+      # This kind of ActiveResource::Base.connection gets connection
+      # by <tt>super</tt> and restores it's default header, then it
+      # sets all the custom headers and clears @with_headers.
+      #
+      # Returns #ActiveResource::Connection
+      def connection
+        @custom_connection = super
+        toggle_default_header
+        set_headers
+        @with_headers = nil
+        @custom_connection
+      end
+
+    private
+      # Saves connection default header for first time, and restores it
+      # in connection every next time.
+      def toggle_default_header
+        if @last_default_header
+          @custom_connection.send(:default_header).clear
+          @custom_connection.send(:default_header).update(@last_default_header)
+        else
+          @last_default_header = @custom_connection.send(:default_header)
+        end
+      end
+
+      # Sets all the custom headers, defined by #custom_headers and #with_headers
+      def set_headers
+        headers = @custom_headers ? @custom_headers.call : {}
+        headers = headers.deep_merge((@with_headers || {}))
+        @custom_connection.send(:default_header).update(headers)
+      end
+    end
+
+  end
+end

data/lib/activeresource_headers/version.rb

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

data/spec/activeresource_headers/custom_headers_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe ActiveresourceHeaders::CustomHeaders do
+
+  require File.expand_path('spec/spec_helper')
+
+  describe "while using #custom_headers class method" do
+    before(:each) do
+      unset_const(:Profile)
+      class Profile < ActiveResource::Base
+        include ActiveresourceHeaders::CustomHeaders
+
+        self.site = REMOTE_HOST
+
+        custom_headers do
+          {time: self.time}
+        end
+      end
+      FakeWeb.register_uri(:get, "#{REMOTE_HOST}/profiles.json", body: [].to_json)
+      Profile.stub(:time).and_return("yesterday")
+    end
+
+    it "runs it's block each time" do
+      Profile.find(:all)
+      FakeWeb.last_request[:time].should eq('yesterday')
+
+      Profile.stub(:time).and_return("tomorrow")
+
+      Profile.find(:all)
+      FakeWeb.last_request[:time].should eq('tomorrow')
+    end
+
+    it "deeply merges it's headers from #with_headers method" do
+      Profile.with_headers(time: 'Soon!').find(:all)
+      FakeWeb.last_request[:time].should eq('Soon!')
+    end
+  end
+
+  describe "#with_headers" do
+    before(:each) do
+      unset_const(:Profile)
+      class Profile < ActiveResource::Base
+        include ActiveresourceHeaders::CustomHeaders
+        self.site = REMOTE_HOST
+      end
+      FakeWeb.register_uri(:get, "#{REMOTE_HOST}/profiles.json", body: [].to_json)
+      Profile.with_headers('Authorization' => 'OAuth2 token', 'Client-Id' => 'xyz').find(:all)
+    end
+    it "is chainable method for adding custom headers for the request" do
+      FakeWeb.last_request["authorization"].should  eq('OAuth2 token')
+      FakeWeb.last_request["client-id"].should      eq('xyz')
+    end
+
+    it "don't remembers it's custom headers between requests" do
+      FakeWeb.register_uri(:get, "#{REMOTE_HOST}/profiles.json?hello=world", body: [].to_json)
+      Profile.find(:all, params: {hello: 'world'})
+      FakeWeb.last_request["authorization"].should  be_nil
+      FakeWeb.last_request["client-id"].should      be_nil
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+require 'fake_web'
+
+require 'activeresource_headers'
+
+require 'active_resource'
+require 'active_support/inflector'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+
+  config.before(:suite) do
+    FakeWeb.allow_net_connect = false
+  end
+
+  config.after(:each) do
+    FakeWeb.clean_registry
+  end
+end
+
+REMOTE_HOST = "http://127.0.0.1:3000"
+
+def unset_const(const_name)
+  const_name = const_name.to_sym
+  const_owner = Module.constants.select { |c| c.to_s.constantize.constants(false).include?(const_name) rescue false }.first.to_s.constantize
+  !const_owner.send(:remove_const, const_name) rescue true
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: activeresource_headers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Denis Yagofarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Send custom headers with ActiveResource requests
+email:
+- denyago@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeresource_headers.gemspec
+- lib/activeresource_headers.rb
+- lib/activeresource_headers/custom_headers.rb
+- lib/activeresource_headers/version.rb
+- spec/activeresource_headers/custom_headers_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds custom_headers { ... } method to ActiveResource model. Those headers
+  merged to deafult ones, each time AR requests api.
+test_files:
+- spec/activeresource_headers/custom_headers_spec.rb
+- spec/spec_helper.rb