epaybg 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45239c656f82ff2132ca9fe16e741f8e32dc2e64
+  data.tar.gz: 2b0e1aff8b514c1d5c36a0b0a39634b08c8c0295
+SHA512:
+  metadata.gz: 3e000ddb03b5b5c862afe7ce69560a5ee816f8b35db4dab0896514943ded9d63d656ed520f72a336368f749e4026193cbc9ed4908386186a164586e726238d1e
+  data.tar.gz: 89595e590c3f5bc75cce1a803d705325e07ef798404bf54d4cfe51a5076bfc1028cea91702168f4761e20d11850c1846d68f4568eaf18d829c97c1f2fdba4d36

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log

data/README.md

@@ -2,6 +2,9 @@
 [![Code Climate](https://codeclimate.com/github/gmitrev/epaybg.png)](https://codeclimate.com/github/gmitrev/epaybg)
 [![Build Status](https://travis-ci.org/gmitrev/epaybg.png?branch=master)](https://travis-ci.org/gmitrev/epaybg)
 
+Rails-specific library for working with the Epay.bg API. More information at
+https://demo.epay.bg/?page=login
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,9 +19,53 @@ Or install it yourself as:
 
     $ gem install epaybg
 
+## Configuration
+
+Create the config file config/epaybg.yml with the following contents:
+
+```yml
+production:
+  secret: YOUR-SECRET-KEY
+  min: YOUR-MIN
+  url: "https://epay.bg"
+  url_idn: "https://epay.bg/ezp/reg_bill.cgi"
+
+test:
+  secret: YOUR-SECRET-KEY
+  min: YOUR-MIN
+  url: "https://demo.epay.bg"
+  url_idn: "https://demo.epay.bg/ezp/reg_bill.cgi"
+```
+
+Set the mode to production in your config/environments/production.rb file:
+
+```ruby
+# Add to bottom of the file
+Epaybg.mode = :production
+```
+
 ## Usage
+Handle a response callback from epay:
+
+```ruby
+response = Epaybg::Response.new(params[:encoded], params[:checksum])
+response.valid?
+# => true
+
+response.status
+# => "PAID"
+```
+
+Respond to their callback:
+```ruby
+response = Epaybg::Response.new(params[:encoded], params[:checksum])
+
+response.invoice
+=> "f5b1eaf"
 
-TODO: Write usage instructions here
+response.response_for(:ok)
+=> "INVOICE=f5b1eaf:STATUS=PAID"
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/epaybg.gemspec

@@ -4,22 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'epaybg/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "epaybg"
+  gem.name          = 'epaybg'
   gem.version       = Epaybg::VERSION
-  gem.authors       = ["gmitrev"]
-  gem.email         = ["gvmitrev@gmail.com"]
-  gem.description   = %q{Framework for dealing with epay.bg payments.}
-  gem.summary       = %q{Epaybg provides integration with the epay.bg payment services. It supports payments through epay.bg, credit cards and in EasyPay offices. }
-  gem.homepage      = "http://github.com/gmitrev/epaybg"
+  gem.authors       = ['gmitrev']
+  gem.email         = ['gvmitrev@gmail.com']
+  gem.description   = 'Gem for dealing with epay.bg payments.'
+  gem.summary       = 'Epaybg provides integration with the epay.bg payment services. It supports payments through epay.bg, credit cards and in EasyPay offices. '
+  gem.homepage      = 'http://github.com/gmitrev/epaybg'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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"]
+  gem.require_paths = ['lib']
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'rspec-rails'
-  gem.add_development_dependency 'rails'
-  gem.add_development_dependency 'coveralls'
 end

data/lib/epaybg.rb

@@ -1,14 +1,12 @@
 require 'epaybg/railtie'
 require 'epaybg/transaction'
 require 'epaybg/response'
-require "epaybg/version"
+require 'epaybg/version'
 
 module Epaybg
-
   class << self
-
     def hmac(data)
-      OpenSSL::HMAC.hexdigest('sha1', config["secret"], data)
+      OpenSSL::HMAC.hexdigest('sha1', config['secret'], data)
     end
 
     # Configuration is loaded based on this property.
@@ -20,21 +18,20 @@ module Epaybg
     def mode=(mode)
       valid = [:test, :production]
       raise ArgumentError, "#{mode} is not a valid mode for Epaybg.
-        Valid modes are #{valid.to_s}." unless valid.include?(mode)
+        Valid modes are #{valid}." unless valid.include?(mode)
       @@mode = mode
     end
 
-    @@mode = :production
+    @@mode = :test
 
     # A hash containing the configuration options found in the
     # config/epaybg.yml file.
     def config
-      @@config[self.mode.to_s]
+      @@config[mode.to_s]
     end
 
     def config=(config)
       @@config = config
     end
-      
   end
 end

data/lib/epaybg/railtie.rb

@@ -2,12 +2,12 @@ require 'epaybg/view_helpers'
 
 module Epaybg
   class Railtie < Rails::Railtie
-    initializer "epaybg.view_helpers" do
+    initializer 'epaybg.view_helpers' do
       ActionView::Base.send :include, Epaybg::ViewHelpers
     end
 
-    initializer "epaybg.configure" do |app|
-      Epaybg.config = YAML.load_file(app.root.join("config", "epaybg.yml"))
+    initializer 'epaybg.configure' do |app|
+      Epaybg.config = YAML.load_file(app.root.join('config', 'epaybg.yml'))
     end
   end
 end

data/lib/epaybg/response.rb

@@ -1,5 +1,4 @@
 module Epaybg
-
   class Response
     attr_accessor :encoded, :checksum
 
@@ -13,24 +12,32 @@ module Epaybg
     end
 
     def to_hash
-      i = decoded.strip.split(":").flat_map{ |c| c.split("=")}
+      i = decoded.strip.split(':').flat_map { |c| c.split('=') }
       Hash[*i]
     end
 
     def valid?
-      Epaybg::hmac(@encoded) == @checksum
+      Epaybg.hmac(@encoded) == @checksum
     end
 
     def status
-      to_hash["STATUS"]
+      to_hash['STATUS']
     end
 
     def invoice
-      to_hash["INVOICE"]
+      to_hash['INVOICE']
+    end
+
+    def stan
+      to_hash['STAN'] if status == 'PAID'
+    end
+
+    def bcode
+      to_hash['BCODE'] if status == 'PAID'
     end
 
     def paid_on
-      DateTime.parse(to_hash["PAY_TIME"]) if status == "PAID"
+      DateTime.parse(to_hash['PAY_TIME']) if status == 'PAID'
     end
 
     def [](key)
@@ -40,8 +47,7 @@ module Epaybg
     def response_for(status)
       response_statuses = [:ok, :err]
       raise "Status must be one of #{response_statuses}" unless response_statuses.include? status
-      "INVOICE=#{self.to_hash["INVOICE"]}:STATUS=#{status.to_s.upcase}"
+      "INVOICE=#{to_hash['INVOICE']}:STATUS=#{status.to_s.upcase}"
     end
-
   end
 end

data/lib/epaybg/transaction.rb

@@ -1,15 +1,13 @@
 require 'net/http'
 
 module Epaybg
-
   class Transaction
-
     attr_accessor :url, :url_idn, :invoice, :amount, :expires_on,
-      :description, :encoding, :url_ok, :url_cancel
+                  :description, :encoding, :url_ok, :url_cancel
 
     def initialize(args = {})
       set_defaults!
-      args.each do |k,v|
+      args.each do |k, v|
         instance_variable_set("@#{k}", v) unless v.nil?
       end
       yield self if block_given?
@@ -17,25 +15,25 @@ module Epaybg
     end
 
     def encoded
-      exp_time = self.expires_on.strftime("%d.%m.%Y")
+      exp_time = expires_on.strftime('%d.%m.%Y')
 
       data = <<-DATA
-        MIN=#{Epaybg.config["min"]}
-        LANG=bg
-        INVOICE=#{self.invoice}
-        AMOUNT=#{self.amount}
-        EXP_TIME=#{exp_time}
+MIN=#{Epaybg.config['min']}
+LANG=bg
+INVOICE=#{invoice}
+AMOUNT=#{amount}
+EXP_TIME=#{exp_time}
       DATA
 
       Base64.strict_encode64(data)
     end
 
     def checksum
-      Epaybg::hmac(encoded)
+      Epaybg.hmac(encoded)
     end
 
     def register_payment
-      uri = URI("#{self.url_idn}/?ENCODED=#{self.encoded}&CHECKSUM=#{self.checksum}")
+      uri = URI("#{url_idn}/?ENCODED=#{encoded}&CHECKSUM=#{checksum}")
 
       http             = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl     = true
@@ -45,31 +43,29 @@ module Epaybg
     end
 
     def epay_link
-      base_link "paylogin"
+      base_link 'paylogin'
     end
 
     def credit_card_link
-      base_link "credit_paydirect"
+      base_link 'credit_paydirect'
     end
 
     private
 
     def base_link(action)
-      "#{self.url}/?PAGE=#{action}&ENCODED=#{self.encoded}&CHECKSUM=#{self.checksum}&URL_OK=#{self.url_ok}&URL_CANCEL=#{self.url_cancel}" 
+      "#{url}/?PAGE=#{action}&ENCODED=#{encoded}&CHECKSUM=#{checksum}&URL_OK=#{url_ok}&URL_CANCEL=#{url_cancel}"
     end
 
     def validate!
       [:invoice, :amount, :expires_on].each do |a|
-        raise ArgumentError, "Missing requried attribute: #{a}" if self.send(a).blank?
+        raise ArgumentError, "Missing requried attribute: #{a}" if send(a).blank?
       end
     end
 
     def set_defaults!
-      @url      ||= Epaybg.config["url"]
-      @url_idn  ||= Epaybg.config["url_idn"]
+      @url ||= Epaybg.config['url']
+      @url_idn ||= Epaybg.config['url_idn']
       @encoding ||= 'utf-8'
     end
-
   end
-
 end

data/lib/epaybg/version.rb

@@ -1,3 +1,3 @@
 module Epaybg
-  VERSION = "0.1.2"
+  VERSION = '0.2.0'
 end

data/lib/epaybg/view_helpers.rb

@@ -1,17 +1,15 @@
 module Epaybg
   module ViewHelpers
-
-    def link_base(p, action, image="")
-      link_to image_tag(image), "#{p.url}/?PAGE=#{action}&ENCODED=#{p.encoded}&CHECKSUM=#{p.checksum}&URL_OK=#{p.url_ok}&URL_CANCEL=#{p.url_cancel}" 
+    def link_base(p, action, image = '')
+      link_to image_tag(image), "#{p.url}/?PAGE=#{action}&ENCODED=#{p.encoded}&CHECKSUM=#{p.checksum}&URL_OK=#{p.url_ok}&URL_CANCEL=#{p.url_cancel}"
     end
 
     def epay_link(p)
-      link_base p, "paylogin", "pay_with_epay.png"
+      link_base p, 'paylogin', 'pay_with_epay.png'
     end
 
     def credit_card_link(p)
-      link_base p, "credit_paydirect", 'pay_with_credit_card.jpg'
+      link_base p, 'credit_paydirect', 'pay_with_credit_card.jpg'
     end
-
   end
 end

metadata

@@ -1,106 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: epaybg
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - gmitrev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   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: rspec-rails
-  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: rails
-  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: coveralls
-  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'
-description: Framework for dealing with epay.bg payments.
+description: Gem for dealing with epay.bg payments.
 email:
 - gvmitrev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,34 +60,28 @@ files:
 - lib/epaybg/version.rb
 - lib/epaybg/view_helpers.rb
 - log/test.log
-- spec/spec_helper.rb
-- spec/unit/transaction_spec.rb
 homepage: http://github.com/gmitrev/epaybg
 licenses: []
+metadata: {}
 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.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Epaybg provides integration with the epay.bg payment services. It supports
   payments through epay.bg, credit cards and in EasyPay offices.
-test_files:
-- spec/spec_helper.rb
-- spec/unit/transaction_spec.rb
-has_rdoc: 
+test_files: []

data/spec/spec_helper.rb

@@ -1,16 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'coveralls'
-Coveralls.wear!
-
-require "action_controller/railtie"
-require 'rspec/rails'
-
-RSpec.configure do |config|
-end
-
-require 'epaybg'
-Epaybg.config = {
-  "test" => {"secret"=>"QESI7RA4BCW95TZPH2OM7583DCP250CEVWZYMM69E8GRS38932W54DWYI9KNCMZ0", "min"=>"D760738416", "url"=>"https://demo.epay.bg", "url_idn"=>"https://demo.epay.bg/ezp/reg_bill.cgi"},
-  "production" => {"secret"=>"n/a", "min"=>"n/a", "url"=>"https://epay.bg", "url_idn"=>"https://epay.bg/ezp/reg_bill.cgi"}
-}

data/spec/unit/transaction_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe Epaybg::Transaction do
-  let :attributes do
-    { invoice: "12345", amount: 69.99, expires_on: Date.tomorrow  }
-  end
-
-  describe "initialization" do
-    it "accepts a hash with options" do
-      lambda do
-        Epaybg::Transaction.new(attributes)
-      end.should_not raise_error ArgumentError
-    end
-
-    it "accepts a block with options" do
-      lambda do
-        Epaybg::Transaction.new do |t|
-          t.amount = attributes[:amount]
-          t.price = attributes[:price]
-          t.expires_on = attributes[:expires_on]
-        end
-      end.should_not raise_error ArgumentError
-    end
-
-    it "doesn't initialize without no options" do
-      lambda do
-        Epaybg::Transaction.new
-      end.should raise_error ArgumentError
-
-    end
-
-    [:invoice, :amount, :expires_on].each do |attr|
-      it "fails when no #{attr} is given" do
-        lambda do
-          Epaybg::Transaction.new(attributes.except(attr))
-        end.should raise_error ArgumentError
-      end
-    end
-  end
-end