faturando_api 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Grasshopper Group, LLC
+
+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,51 @@
+Faturando Api (usando ActiveResource)
+====================================================
+
+faturando_api
+-----------------
+
+Permite acessar a API do [Faturando](http://faturan.do) usando ActiveResource.
+
+
+### Instalação
+
+Esta biblioteca pode ser instalada como uma e está disponível no [Rubygems](http://rubygems.org).
+
+Para instalar basta executar o seguinte comando:
+
+$ gem install faturando_api
+
+
+### Requisitos
+
+Esta biblioteca depende do ActiveResource com versão 2.3.4 ou maior.
+
+$ gem install activeresource
+
+
+### Utilização
+
+Para utilizar a biblioteca basta importá-la utilizando:
+
+    gem 'faturando_api'
+
+
+Se você está usando Rails 3 basta adicionar a seguinte linha no Gemfile:
+
+    gem 'faturando_api'
+
+Se você está usando Rails 2.3.X basta adicionar a seguinte linha na configuração da aplicação,
+por exemplo, no `environment.rb`
+
+    config.gem 'faturando_api'
+
+### Configurando
+
+Para poder se comunicar com o Faturando você precisa configurar a chave da API e o código do produto a ser utilizado.
+
+Faturando.configure do |c|
+  c.project_key = '1234'
+  c.api_key   = 'XYZ'
+end
+
+Se você estiver utilizando Rails deve preferêncialmente criar um initializer.

data/lib/faturando/version.rb

@@ -0,0 +1,3 @@
+module Faturando
+  VERSION = "0.1.0"
+end

data/lib/faturando_api.rb

@@ -0,0 +1,116 @@
+begin
+  require 'active_resource'
+rescue LoadError
+  begin
+    require 'rubygems'
+    require 'active_resource'
+  rescue LoadError
+    abort <<-ERROR
+The 'activeresource' library could not be loaded. If you have RubyGems
+installed you can install ActiveResource by doing "gem install activeresource".
+ERROR
+  end
+end
+
+
+# Version check
+module Faturando
+  MIN_VERSION = '2.3.4'
+end
+require 'active_resource/version'
+unless Gem::Version.new(ActiveResource::VERSION::STRING) >= Gem::Version.new(Faturando::MIN_VERSION)
+  abort <<-ERROR
+    ActiveResource version #{Faturando::MIN_VERSION} or greater is required.
+  ERROR
+end
+
+# Patch ActiveResource version 2.3.4
+if ActiveResource::VERSION::STRING == '2.3.4'
+  module ActiveResource
+    class Base
+      def save
+        save_without_validation
+        true
+      rescue ResourceInvalid => error
+        case error.response['Content-Type']
+        when /application\/xml/
+          errors.from_xml(error.response.body)
+        when /application\/json/
+          errors.from_json(error.response.body)
+        end
+        false
+      end
+    end
+  end
+end
+
+module Faturando
+  class << self
+    attr_accessor :project_key, :api_key, :site, :format, :timeout
+
+    def configure
+      yield self
+
+      Base.user      = api_key
+      Base.password  = 'X'
+      Base.timeout   = timeout unless (timeout.blank?)
+
+      self.site ||= "https://faturan.do/"
+
+      base_path = site + "/projects/#{project_key}"
+      Base.site = base_path
+      FeatureValue.site = base_path + "/plans/:plan_id"
+    end
+  end
+
+  class Base < ActiveResource::Base
+    self.format = :xml
+
+    def self.element_name
+      name.split(/::/).last.underscore
+    end
+
+    def to_xml(options = {})
+      options.merge!(:dasherize => false)
+      super
+    end
+  end
+
+  class Feature < Base
+  end
+
+  class FeatureValue < Base
+  end
+
+  class Plan < Base
+    def self.subscribible
+      self.all.select(&:subscribible)
+    end
+
+    def feature_value_by_handle(handle)
+      found = feature_values.select do |feature_value|
+        feature_value.feature.handle == handle
+      end
+      found.first
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s.match(/^unlimited_(.+)\?$/)
+        feature_value = feature_value_by_handle($1)
+        if feature_value
+          return feature_value.unlimited
+        end
+      end
+
+      begin
+        super
+      rescue NoMethodError => e
+        feature_value = feature_value_by_handle(method.to_s)
+        if feature_value
+          return feature_value.value
+        end
+        raise(e)
+      end
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Faturando::Base do
+  it 'parses element names' do
+    Faturando::Base.stub!(:name).and_return("Test::Namespace::ElementName")
+    Faturando::Base.element_name.should eql('element_name')
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+  sequence :plan_name do |n|
+    "Plan #{n}"
+  end
+
+  factory :plan, :class => Faturando::Plan do |p|
+    p.name          { FactoryGirl.generate(:plan_name) }
+    p.value         { 19.99 }
+    p.subscribible  { true }
+  end
+
+  factory :feature, :class => Faturando::Feature do |f|
+    f.name        { Faker::Name.name }
+    f.type        { 'Features::Numeric' }
+    f.description { Faker::Lorem.sentence }
+  end
+end

data/spec/mocks/fake_resource.rb

@@ -0,0 +1,82 @@
+# Taken from https://gist.github.com/238158/487a411c392e1fb2a0c00347e32444320f5cdd49
+require 'fakeweb'
+
+module ActiveResource
+
+  #
+  # The FakeResource fakes ActiveResources so that no real resources are transferred. It catches the creation methods
+  # and stores the resources internally instead of sending to a remote service and responds these resources back on
+  # request.
+  #
+  # Additionally it adds a save! method and can be used in conjunction with Cucumber/Pickle/FactoryGirl to fully
+  # fake a back end service in the BDD cycle
+  #
+  module FakeResource
+
+    @@fake_resources = []
+
+    def self.clean
+      FakeWeb.clean_registry
+      @@fake_resources = []
+    end
+
+    def self.included(base)
+      base.class_eval do
+
+        def save
+          @@fake_resources << self
+          update_fake_responses
+        end
+
+        def destroy
+          @@fake_resources.delete(self)
+          update_fake_responses
+        end
+
+        def self.delete(id, options = {})
+          puts "delete"
+          @@fake_resources.delete_if {|r| r.id == id }
+          #update_fake_responses
+        end
+
+        def self.exists?(id, options = {})
+          not @@fake_resources.select {|r| r.id == id}.blank?
+        end
+
+      end
+    end
+
+    def save!
+      save
+    end
+
+    def save
+      super
+    end
+
+    private
+
+      def update_fake_responses
+        FakeWeb.clean_registry
+
+        @@fake_resources.each do |r|
+          FakeWeb.register_uri(:get, element_uri, :body => r.to_xml)
+        end
+
+        FakeWeb.register_uri(:get, collection_uri, :body => @@fake_resources.to_xml)
+      end
+
+      def element_uri
+        "#{base_uri}#{element_path}"
+      end
+
+      def collection_uri
+        "#{base_uri}#{collection_path}"
+      end
+
+      def base_uri
+        "#{connection.site.scheme}://#{connection.user}:#{connection.password}@#{connection.site.host}:#{connection.site.port}"
+      end
+
+    end
+end

data/spec/plan_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Faturando::Plan do
+
+  context 'subscribible' do
+    before do
+      @subscribible_plan = Factory(:plan, :subscribible => true)
+      @non_subscribible_plan = Factory(:plan, :subscribible => false)
+
+      @all = [@subscribible_plan, @non_subscribible_plan]
+      FakeWeb.register_uri(:get, "/project/1234/#{test_domain}/plans.xml", :body => @all.to_xml)
+    end
+
+    it 'finds only subscribible plans' do
+      Faturando::Plan.subscribible.should == [@subscribible_plan]
+    end
+  end
+
+  it "find a feature value based on handle" do
+    plan = Factory(:plan)
+    feature = Factory(:feature, handle: 'notas_fiscais')
+    plan.feature_values = [
+      Faturando::FeatureValue.create(plan: plan, feature: feature, value: 'XXXX')
+    ]
+
+    plan.feature_value_by_handle('notas_fiscais').should == plan.feature_values.first
+    plan.feature_value_by_handle('non_exising').should == nil
+  end
+
+  it "has virtual methods based on feature handles" do
+    plan = Factory(:plan)
+    feature_notas = Factory(:feature, handle: 'notas_fiscais')
+    feature_email = Factory(:feature, handle: 'emails_limit')
+    plan.feature_values = [
+      Faturando::FeatureValue.create(plan: plan, feature: feature_notas, value: 'XXXX'),
+      Faturando::FeatureValue.create(plan: plan, feature: feature_email, value: 'YYYY')
+    ]
+
+    plan.notas_fiscais.should == 'XXXX'
+    plan.emails_limit.should == 'YYYY'
+
+    expect {
+      plan.notas_fiscais_limit
+    }.to raise_error(NoMethodError)
+  end
+
+  it "has virtual methods to discover if a feature is unlimited" do
+    plan = Factory(:plan)
+    feature_notas = Factory(:feature, handle: 'notas_fiscais')
+    feature_email = Factory(:feature, handle: 'emails_limit')
+    plan.feature_values = [
+      Faturando::FeatureValue.create(plan: plan, feature: feature_notas, value: 'XXXX', unlimited: true),
+      Faturando::FeatureValue.create(plan: plan, feature: feature_email, value: 'YYYY', unlimited: false)
+    ]
+
+    plan.unlimited_notas_fiscais?.should be_true
+    plan.unlimited_emails_limit?.should be_false
+
+    plan.unlimited_notas_fiscais_test? be_nil
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rspec'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'faturando_api'
+
+require 'fakeweb'
+require 'mocks/fake_resource'
+ActiveResource::Base.send :include, ActiveResource::FakeResource
+FakeWeb.allow_net_connect = false
+require 'factory_girl'
+require 'faker'
+require 'factories'
+
+Faturando.configure do |c|
+  c.project_key = '1234'
+  c.api_key   = 'test'
+end
+
+RSpec.configure do |config|
+  config.after(:each) do
+    ActiveResource::FakeResource.clean
+  end
+end
+
+def test_domain
+  "#{Faturando::Base.connection.site.scheme}://#{Faturando::Base.connection.user}:#{Faturando::Base.connection.password}@#{Faturando::Base.connection.site.host}:#{Faturando::Base.connection.site.port}"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: faturando_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Anderson Dias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &85280580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85280580
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &85280340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85280340
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &85280120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85280120
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &85279890 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85279890
+- !ruby/object:Gem::Dependency
+  name: active_resource
+  requirement: &85279670 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *85279670
+description: A Faturando API wrapper for Ruby using ActiveResource
+email:
+- andersondaraujo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/faturando/version.rb
+- lib/faturando_api.rb
+- LICENSE
+- README.md
+- spec/mocks/fake_resource.rb
+- spec/spec_helper.rb
+- spec/plan_spec.rb
+- spec/factories.rb
+- spec/spec.opts
+- spec/base_spec.rb
+homepage: http://github.com/tink/faturando_api
+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: faturando_api
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A Faturando API wrapper for Ruby using ActiveResource
+test_files:
+- spec/mocks/fake_resource.rb
+- spec/spec_helper.rb
+- spec/plan_spec.rb
+- spec/factories.rb
+- spec/spec.opts
+- spec/base_spec.rb