compropago 0.0.2 → 0.1.0

data/README.md

@@ -6,7 +6,7 @@ This gem helps you integrate ComproPago's API to your ruby app.
 
 Add this line to your application's Gemfile:
 
-    gem 'compropago', '~> 0.0.1'
+    gem 'compropago', '~> 0.1.0'
 
 And then execute:
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 We encourage you to set your API keys in an environment variable rather than hardcoding your API keys.
 
-    compropago = Compropago::Client.new(ENV['COMPROPAGO_API_KEY'])
+     Compropago.api_key = "sk_test_my_api_key"
 
 Once you have created an instance of compropago, you can call the methods described in the <a href="http://compropago.com/documentacion/api">api reference</a> on it.
 
@@ -32,32 +32,31 @@ Once you have created an instance of compropago, you can call the methods descri
 ### Create a charge
 
 Creating a charge using only the required params <code>product_price</code>, <code>product_name</code>, <code>customer_name</code>, <code>customer_email</code>, <code>payment_type</code>.
-	
-	# create_charge(product_price, product_name, customer_name, customer_email, payment_type)
 
-    compropago.create_charge(3150.0, 'iphone5s', 'Irma Sanz', 'no-replay@compropago.com', 'OXXO')
-
-Adding the optional params <code>product_id</code> and <code>image_url</code> to the request:
-
-    # create_charge(product_price, product_name, customer_name, customer_email, payment_type, product_id, image_url)
-
-    compropago.create_charge(3150.0, 'iphone5s', 'Irma Sanz', 'no-replay@email.com', 'OXXO', '5ku8g', 'image.jpg')
+```ruby
+ Compropago::Charge.create({ product_price: 10000.0,
+                             product_name: "SAMSUNG GOLD CURL",
+                             customer_name: "Roberto Miranda",
+                             customer_email: "noreply@compropago.com",
+                             payment_type: "OXXO"})
+```
 
 ### Verify a charge
 
 Verify a charge previously made.
 
-	# verify_charge(payment_id)
-
-    compropago.verify_charge('b75076ac-a94b-478a-945c-c2caf85be668')
+```ruby
+Compropago::Charge.find("818f2e81-226a-4ff9-88a2-81a577aec380")
+```
 
 ### SMS payment instructions
 
 Send payment instructions over SMS.
 
-	# send_payment_instructions(payment_id, customer_phone, customer_company_phone)
+```ruby
+Compropago::SMS.create(payment_id: "818f2e81-226a-4ff9-88a2-81a577aec380", customer_phone: "2221515805", customer_company_phone: "TELCEL")
+```
 
-    compropago.send_payment_instructions('b75076ac-a94b-478a-945c-c2caf85be668', '2221515805', 'TELCEL')
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,31 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :console do
+  Rake::Task["build"].invoke
+  Rake::Task["install"].invoke
+  puts "Loading development console..."
+  system("irb -r compropago")
+end
+
+task :help do
+  puts "Available rake tasks: "
+  puts "rake console - Run a IRB console with all enviroment loaded"
+  puts "rake test - Run tests"
+end
+
+Rake::TestTask.new("test:regular") do |t|
+  t.libs = ["test"]
+  t.pattern = "test/*_test.rb"
+  t.ruby_opts = ['-w']
+end
+
+Rake::TestTask.new("test:models") do |t|
+  t.libs = ["test"]
+  t.pattern = "test/models/*_test.rb"
+  t.ruby_opts = ['-w']
+end
+
+task :default => :test
+task :test => ['test:regular', 'test:models']

data/compropago.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "active_rest_client", "~> 1.0.4"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock", "~> 1.16.1"
 end

data/example/example.rb

@@ -0,0 +1,15 @@
+require "compropago"
+ Compropago.api_key = "sk_test_my_api_key"
+ Compropago::Charge.find("1")
+
+ Compropago::Charge.create({ product_price: 10000.0,
+                             product_name: "SAMSUNG GOLD CURL",
+                             customer_name: "Roberto Miranda",
+                             customer_email: "noreply@compropago.com",
+                             payment_type: "OXXO"})
+ #=>
+#<Compropago::Charge:0x007f99abb13220 @attributes={:payment_id=>"818f2e81-226a-4ff9-88a2-81a577aec380", :short_payment_id=>"b05aed", :payment_status=>"PENDING", :creation_date=>Wed, 30 Jul 2014 18:05:49 -0500, :expiration_date=>Thu, 31 Jul 2014 18:05:49 -0500, :product_information=>#<Compropago::Charge:0x007f99abb10d18 @attributes={:product_id=>"SMGCURL1", :product_name=>"SAMSUNG GOLD CURL", :product_price=>"10000.0"}, @dirty_attributes=#<Set: {}>>, :payment_instructions=>#<Compropago::Charge:0x007f99abb103e0 @attributes={:description=>"Para que el pago sea válido debes pagar la cantidad exacta de $10000.0", :step_1=>"Ir a la caja OXXO de 8:00 am a 8:00 pm", :step_2=>"Solicitar depósito bancario al número: Banco de Pruebas 0000 0000 0000 0000", :step_3=>"Deposite la cantidad exacta de: $10000.0", :note_extra_comition=>"Las tiendas Oxxo cobran en caja una comisión de $7.00 por el concepto de recepción de cobranza.", :note_expiration_date=>"Orden válida antes de 31/07/2014, en caso de vencimiento genera una nueva compra.", :note_confirmation=>"Tu pago será confirmado a través de SMS y correo electronico. ¡Gracias por usar ComproPago!"}, @dirty_attributes=#<Set: {}>>}, @dirty_attributes=#<Set: {}>, @_status=200>
+
+
+
+Compropago::SMS.create(payment_id: "818f2e81-226a-4ff9-88a2-81a577aec380", customer_phone: "2221515805", customer_company_phone: "TELCEL")

data/lib/compropago.rb

@@ -1,13 +1,11 @@
 # API spec at http://compropago.com/documentacion/api
-require 'net/https'
-require 'uri'
-
 # Version
 require 'compropago/version'
-
-# Resources
-require 'compropago/client'
+require "active_rest_client"
+require "compropago/configuration"
 
 module Compropago
-
-end
+  autoload :Base, 'compropago/base'
+  autoload :Charge, 'compropago/charge'
+  autoload :SMS, 'compropago/sms'
+end

data/lib/compropago/base.rb

@@ -0,0 +1,4 @@
+module Compropago
+  class Base < ActiveRestClient::Base
+  end
+end

data/lib/compropago/charge.rb

@@ -0,0 +1,11 @@
+module Compropago
+  class Charge < Base
+     get :find, "/charges/:id"
+     post :create, "/charges"
+
+     STORES = %w(OXXO SEVEN_ELEVEN EXTRA TELECOMM WALMART
+     SORIANA BODEGA_AURRERA SAMS_CLUB CASA_LEY CHEDRAUI PITICO
+     SUPERAMA ELEKTRA COPPEL VIPS EL_PORTON FARMACIA_BENAVIDES
+     FARMACIA_ABC FARMACIA_ESQUIVAR)
+  end
+end

data/lib/compropago/configuration.rb

@@ -0,0 +1,34 @@
+module Compropago
+  # Stores runtime configuration information.
+  #
+  # @example Standard settings
+  #  Compropago.api_url = "https://api.compropago.com/v1"
+  #  Compropago.api_key = "MyAPIKey"
+  ActiveRestClient::Base.base_url = "https://api.compropago.com/v1"
+
+  def self.api_key
+    @api_key
+  end
+
+  def self.api_url
+    ActiveRestClient::Base.base_url
+  end
+
+  def self.api_key=(api_key)
+    @api_key = api_key
+    ActiveRestClient::Base.faraday_config do |faraday|
+      faraday.request  :basic_auth, api_key, nil
+      faraday.request  :url_encoded             # form-encode POST params
+      faraday.response :logger                  # log requests to STDOUT
+      faraday.response :raise_error
+      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+
+      #FIXME https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates#solutions-to-avoid
+      faraday.ssl.merge!({ verify: false })
+    end
+  end
+
+  def self.api_url=(api_url)
+    ActiveRestClient::Base.base_url = api_url
+  end
+end

data/lib/compropago/connection.rb

@@ -0,0 +1,19 @@
+require "uri"
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{ |f| require f }
+module Compropago
+  module Connection
+
+    def api_connection
+      @api_connection = Faraday.new(:url => Compropago.configuration.api_url) do |faraday|
+        faraday.request  :basic_authentication, Compropago.configuration.api_key
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.response :raise_error
+        #faraday.use FaradayMiddleware::RaiseHttpException
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+  end
+end

data/lib/compropago/sms.rb

@@ -0,0 +1,5 @@
+module Compropago
+  class SMS < Base
+     post :create, "/charges/:payment_id/sms"
+  end
+end

data/lib/compropago/version.rb

@@ -1,3 +1,3 @@
 module Compropago
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/configuration_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+class ConfigurationTest < MiniTest::Test
+  def test_must_set_the_conf_vars
+    assert_equal Compropago.api_url, "https://api.compropago.com/v1"
+
+    Compropago.api_url = "https://api.compropago.com/v2"
+    Compropago.api_key = "MyToken"
+    assert_equal Compropago.api_url, "https://api.compropago.com/v2"
+    assert_equal Compropago.api_key, "MyToken"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require "rubygems"
+require "compropago"
+require "minitest/autorun"
+require "minitest/unit"
+require 'webmock/minitest'
+
+class MiniTest::Test
+  def setup
+  end
+end
+
+def load_fixture(name)
+  File.new(File.dirname(__FILE__) + "/fixtures/#{name}.json")
+end
+
+# GET
+def stub_get(path, fixture)
+  stub_request(:get, Regexp.new("#{Compropago.configuration.api_url}#{path}")).
+    to_return(:body => load_fixture(fixture))
+end
+
+# POST
+def stub_post(path, fixture, status_code=200)
+  stub_request(:post, Regexp.new("#{Compropago.configuration.api_url}#{path}")).
+    to_return(:body => load_fixture(fixture), :status => status_code)
+end
+
+# PUT
+def stub_put(path, fixture)
+  stub_request(:put, Regexp.new("#{Compropago.configuration.api_url}#{path}")).
+    to_return(:body => load_fixture(fixture))
+end
+
+
+# DELETE
+def stub_delete(path)
+  stub_request(:delete, Regexp.new("#{Compropago.configuration.api_url}#{path}"))
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compropago
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-26 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_rest_client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.1
 description: Ruby gem for making calls to ComproPago API
 email:
 - soporte@compropago.com
@@ -56,9 +104,17 @@ files:
 - README.md
 - Rakefile
 - compropago.gemspec
+- example/example.rb
 - lib/compropago.rb
+- lib/compropago/base.rb
+- lib/compropago/charge.rb
 - lib/compropago/client.rb
+- lib/compropago/configuration.rb
+- lib/compropago/connection.rb
+- lib/compropago/sms.rb
 - lib/compropago/version.rb
+- test/configuration_test.rb
+- test/test_helper.rb
 homepage: http://compropago.com
 licenses:
 - MIT
@@ -72,22 +128,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2503675149839758176
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2503675149839758176
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for ComproPago
-test_files: []
+test_files:
+- test/configuration_test.rb
+- test/test_helper.rb