cobregratis 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+cobregratis.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rafael Lima
+
+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.mkdn

@@ -0,0 +1,71 @@
+# Cobregratis (0.1.0)
+
+## What is it?
+
+This gem provides a set of classes to access information on [Cobre Grátis][cg] via the published [API][api].
+
+All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveResouce][ar] documentation for more information.
+
+## Installing
+
+    gem install cobregratis
+
+### Dependencies (see the Rakefile or run <code>rake check_dependencies</code>)
+
+### Documentation
+
+  I'm on [rdoc.info][rdoc]
+
+### Configure your key
+    
+    require 'rubygems'
+    require 'cobregratis'
+    
+    Cobregratis::Base.site = 'https://app.cobregratis.com.br'
+    Cobregratis::Base.user = 'your_api_username'
+    Cobregratis::Base.password = 'your_api_password'
+
+and, if you want [caching][c]:
+
+    Cobregratis::Base.connection.cache_store= <your normal ActiveSupport::Caching options>
+    
+If you are using this in a Rails application, putting this code in a config/initializers/cobregratis.rb
+file is recommended. See config_initializers_cobregratis.rb in the examples/ directory.
+
+## Usage
+
+    @billets = Cobregratis::Billet.find(:all)
+
+## License
+
+This code is free to be used under the terms of the [MIT license][mit].
+
+## Bugs, Issues, Kudos and Catcalls
+
+Comments are welcome. Send your feedback through the [issue tracker on GitHub][i]
+
+## Author
+
+### **Rafael Lima**
+
+Working at [BielSystems](http://bielsystems.com.br)
+
+Blog: [http://rafael.adm.br](http://rafael.adm.br)
+
+Podcast: [http://rafael.adm.br/voltandopracasa](http://rafael.adm.br/voltandopracasa)
+
+Github: [http://github.com/rafaelp](http://github.com/rafaelp)
+
+Twitter: [http://twitter.com/rafaelp](http://twitter.com/rafaelp)
+
+### Did you like?
+
+[Recommend me at Working With Rails](http://workingwithrails.com/recommendation/new/person/14248-rafael-lima)
+
+[api]: http://app.cobregratis.com.br/api
+[ar]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
+[c]:  http://api.rubyonrails.org/classes/ActiveSupport/Cache
+[cg]:  http://cobregratis.com.br/
+[i]:  http://github.com/rafaelp/cobregratis/issues
+[mit]:http://www.opensource.org/licenses/mit-license.php
+[rdoc]: http://rdoc.info/projects/rafaelp/cobregratis

data/Rakefile

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cobregratis"
+    gem.summary = %Q{Ruby Wrapper around Cobre Grátis API}
+    gem.description = %{
+Cobre Grátis
+
+Configure by adding the following:
+
+require 'cobregratis'
+Cobregratis::Base.site = 'https://app.cobregratis.com.br/'
+Cobregratis::Base.user = 'your_api_username'
+Cobregratis::Base.user = 'your_api_password'
+                          }
+    gem.email = "contato@rafael.adm.br"
+    gem.homepage = "http://github.com/rafaelp/cobregratis"
+    gem.authors = ["Rafael Lima"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency('activeresource', '>= 2.1')
+    gem.add_dependency('activesupport', '>= 2.1')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cobregratis #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+Autotest.add_discovery do
+  "rspec"
+end

data/examples/config_initializers_cobregratis.rb

@@ -0,0 +1,13 @@
+if Rails.env != 'test' then
+  Cobregratis::Base.site = 'https://example.com.i'
+  # For backward compatability
+  if Cobregratis::Base.respond_to? :user
+    Cobregratis::Base.user = 'my_fancy_username'
+    Cobregratis::Base.password = 'my_fancy_password'
+  else 
+    Cobregratis::Base.site = 'https://my_fancy_username:my_fancy_password@example.com.i'
+  end
+  # The cache store can be anything that ActiveSupport can handle
+  Cobregratis::Base.connection.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store
+  Cobregratis::Base.connection.store_options = { :expires_in => 60.seconds }
+end

data/examples/sample.rb

@@ -0,0 +1,11 @@
+require 'cobregratis'
+require 'pp'
+
+Cobregratis::Base.site = 'https://app.cobregratis.com.br'
+Cobregratis::Base.user = 'login'
+Cobregratis::Base.password = 'xxx'
+Cobregratis::Base.connection.cache_store = :memory_store
+
+@billets = Cobregratis::Billet.find(:all)
+
+pp @billets

data/init.rb

@@ -0,0 +1 @@
+require 'cobregratis'

data/lib/cachable.rb

@@ -0,0 +1,83 @@
+# Caching is a way to speed up slow ActiveResource queries by keeping the result of
+# a request around to be reused by subsequent requests. 
+# 
+# Caching is turned OFF by default.
+#
+# == Usage
+# 
+#   require 'cachable'
+# 
+#   module CachedResource < ActiveResource::Base
+#     include ::Cachable
+#   end
+#
+#
+# == Caching stores
+#
+# All the caching stores from ActiveSupport::Cache are available
+# as backends for caching. See the Rails rdoc for more information on
+# these stores
+#
+# === Configuration examples ('off' is the default):
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :drb_store, "druby://localhost:9192"
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
+#   CachedResource.connection.cache_store = MyOwnStore.new("parameter")
+#
+# === If you are using a store that has write options, you can set them
+#   CachedResource.connection.cache_options = { :expires_in => 60.seconds }
+#
+# Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = nil
+#
+# FYI: You can use this with *any* active resource class, not just Cobregratis.
+
+module Cachable
+  def self.included(base)
+    ActiveResource::Connection.class_eval do
+      def cache_store
+        @cache_store ||= nil
+      end
+
+      def cache_store=(store)
+        @cache_store = store
+      end
+      
+      def cache_options
+        @cache_options ||= {}
+      end
+      alias :store_options :cache_options
+      
+      def cache_options=(options)
+        @cache_options = options
+      end
+      alias :store_options= :cache_options=
+      
+      def is_caching?
+        !@cache_store.nil?
+      end
+      
+      def get_with_cache(path, headers = {})
+        return get_without_cache(path, headers) unless is_caching?
+        cache_store.fetch(cache_key(path), cache_options) {get_without_cache(path, headers)}
+      end
+      alias_method_chain :get, :cache
+
+      def put_with_cache(path, body = '', headers = {})
+        cache_store.delete(cache_key(path))
+        put_without_cache(path, body, headers)
+      end
+      alias_method_chain :put, :cache
+      
+      def delete_with_cache(path, headers = {})
+        cache_store.delete(cache_key(path))
+        delete_without_cache(path, headers)
+      end
+      alias_method_chain :delete, :cache
+      
+      def cache_key(*args)
+        args.join(':')
+      end
+    end
+  end  
+end

data/lib/cobregratis/base.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../cachable'
+
+module Cobregratis
+  class Base < ActiveResource::Base
+    self.site = "https://app.cobregratis.com.br"
+    include ::Cachable
+  end
+end

data/lib/cobregratis/billet.rb

@@ -0,0 +1,4 @@
+module Cobregratis
+  class Billet < Base
+  end
+end

data/lib/cobregratis.rb

@@ -0,0 +1,5 @@
+require 'active_resource'
+$:.unshift(File.dirname(__FILE__))
+
+require 'cobregratis/base'
+require 'cobregratis/billet'

data/spec/cachable_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class CachedResource < ActiveResource::Base
+  include ::Cachable
+end
+
+describe CachedResource, "class configuration" do
+  before(:each) do
+    CachedResource.site = 'http://example.com.i:3000'
+  end
+    
+  it "should tell us if caching is active" do
+    CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+    CachedResource.connection.is_caching?.should == true
+  end
+  
+  it "should tell us if caching is not active" do
+    CachedResource.connection.cache_store = nil
+    CachedResource.connection.is_caching?.should == false
+  end
+end
+
+describe CachedResource do
+  before(:all) do
+    CachedResource.site = 'http://example.com.i:3000'
+    CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+  end
+  
+  after(:all) do
+    CachedResource.connection.cache_store = :none
+  end
+  
+  before(:each) do
+    @thing = CachedResource.new(:id => 1)
+    @key = :key
+    CachedResource.connection.stub!(:cache_key).and_return(@key)
+  end
+  
+  context "when a cached response is available" do
+    before(:each) do
+      CachedResource.connection.cache_store.write(@key, @thing.attributes)
+    end
+    
+    it "should NOT make a request to the RESTful server" do
+      CachedResource.connection.should_not_receive(:get_without_cache)
+      CachedResource.find(1)
+    end
+    
+    it "should read from the cache" do
+      CachedResource.find(1).should == @thing
+    end
+    
+    it "should delete from the cache when an object is DELETEd" do
+      CachedResource.connection.should_receive(:delete_without_cache)
+      CachedResource.delete(1)
+      CachedResource.connection.cache_store.read(@key).should == nil
+    end
+
+    it "should delete from the cache when an object is modified" do
+      thing = CachedResource.find(1)
+      thing.stub(:load_attributes_from_response).and_return(@thing.attributes)
+      CachedResource.connection.should_receive(:put_without_cache)
+      thing.save
+      CachedResource.connection.cache_store.read(@key).should == nil
+    end
+  end
+  
+  context "when a cached response is NOT available" do
+    before(:each) do
+      CachedResource.connection.cache_store.delete(@key)
+    end
+    
+    it "SHOULD perform an ActiveResource request" do
+      CachedResource.connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      CachedResource.find(1)
+    end
+    
+    it "should cache the response using the caching key" do
+      CachedResource.connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      CachedResource.find(1)
+      CachedResource.connection.cache_store.read(@key).should == @thing.attributes
+    end
+  end
+end

data/spec/cobregratis/base_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Cobregratis::Base do
+  
+  before(:each) do
+    @base = Cobregratis::Base.new
+  end
+  
+  it "should be instance of ActiveResource::Base" do
+    @base.kind_of?(ActiveResource::Base).should be_true
+  end
+  
+end

data/spec/cobregratis/billet_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Cobregratis::Billet do
+  before(:each) do
+    @billet = Cobregratis::Billet.new
+  end
+  
+  it "should be instance of Cobregratis::Base" do
+    @billet.kind_of?(Cobregratis::Base).should be_true
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,8 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+-rubygems
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cobregratis'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: cobregratis
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rafael Lima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-22 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id003
+description: "\n\
+  Cobre Gr\xC3\xA1tis\n\n\
+  Configure by adding the following:\n\n\
+  require 'cobregratis'\n\
+  Cobregratis::Base.site = 'https://app.cobregratis.com.br/'\n\
+  Cobregratis::Base.user = 'your_api_username'\n\
+  Cobregratis::Base.user = 'your_api_password'\n                          "
+email: contato@rafael.adm.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mkdn
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.mkdn
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- examples/config_initializers_cobregratis.rb
+- examples/sample.rb
+- init.rb
+- lib/cachable.rb
+- lib/cobregratis.rb
+- lib/cobregratis/base.rb
+- lib/cobregratis/billet.rb
+- spec/cachable_spec.rb
+- spec/cobregratis/base_spec.rb
+- spec/cobregratis/billet_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rafaelp/cobregratis
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Ruby Wrapper around Cobre Gr\xC3\xA1tis API"
+test_files: 
+- spec/cachable_spec.rb
+- spec/cobregratis/base_spec.rb
+- spec/cobregratis/billet_spec.rb
+- spec/spec_helper.rb
+- examples/config_initializers_cobregratis.rb
+- examples/sample.rb