pesapal 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 417c91efd39cf8a739a0869680ba67e3926f924a
-  data.tar.gz: 28268660a0ddfc0795269c5865487762f755050e
+  metadata.gz: 1b3d98d9279b31f66a9996b6045d19a0ae01c2c7
+  data.tar.gz: e132dc33bd5a88e3c2980e4c5eff9f8bfe438e33
 SHA512:
-  metadata.gz: 13dbf2a7c26cf350980808df0d384054245331d68b6dab29fc595f4f6d29b86a7eb3e69eeaa79f8353954d4c2e3726ec9f527e1c8c89180b76407fc05a5845d7
-  data.tar.gz: e0de54ad41503932cbe7fc5b623b64d4cf83f5a8c84534679f28e61d9e197b4af7f8e73679ba34b2c06192d2981496cd17622833fe00d48d99152c5a32f3cb4d
+  metadata.gz: 64ff6e09c9b02066fe9b78120cc2f60594eea9fc3d23c5c010b2eb9eccce2ef3d5bd0d4d4de20b360f380a171278a18794e472dec65ff69f572e721a1797d61e
+  data.tar.gz: 510c5cadf3d39ed31c86d266c5023c9b79bd087329818401e801a2e3a1075f9bb858f7fd891f89966005b4ca3ce20a44d7571be948069dac60fd4640dc5f0fbb

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+v1.2.1
+------
+
+* Fix severe bug caused by buggy initializer
+
+Ps: Run the install generator again, overwrite the initializer only!
+
 v1.2.0
 ------
 

data/README.md

@@ -16,7 +16,7 @@ other people get to share in the conversation that would have been private and
 out of their reach.
 
 The gem should be [up on RubyGems.org][7], it's [accompanying RubyDoc reference
-here][13] and [all the releases here][12].
+here][13], the [CHANGELOG here][21] and [all the releases here][12].
 
 If you are [feeling generous and want to contribute, feel free][9].
 
@@ -68,9 +68,11 @@ pesapal = Pesapal::Merchant.new(:development)
 
 ####Option 1####
 
-In the case, the configuration has already been loaded (at application start by
-initializer) from a YAML file located at `"#{Rails.root}/config/pesapal.yml"` by
-default. This is the recommended method.
+In the above case, the configuration has already been loaded (at application
+start by initializer) from a YAML file located at
+`"#{Rails.root}/config/pesapal.yml"` by default.
+
+This is the recommended method.
 
 ####Option 2####
 
@@ -124,6 +126,12 @@ production:
     consumer_secret: '<YOUR_CONSUMER_SECRET>'
 ```
 
+_Ps: Immediately after initializing the Pesapal object, some people might find
+it peculiar that the `pesapal.config` is an empty hash i.e. `{}`. Don't worry.
+If you have set up the `pesapal.yml` correctly, any attempt to run any of the
+methods will eventually populate this hash with the values that were loaded by
+the initializer (see option #1 above, stated as the default)._
+
 
 ### Posting An Order ###
 
@@ -133,7 +141,7 @@ you wish to ignore just leave it with a blank string but make sure it's included
 e.g. the phonenumber.
 
 ```ruby
-#set order details 
+#set order details
 pesapal.order_details = { :amount => 1000,
                           :description => 'this is the transaction description',
                           :type => 'MERCHANT',
@@ -201,7 +209,7 @@ payment_details = pesapal.query_payment_details("<MERCHANT_REFERENCE>","<TRANSAC
 The result is a hash that looks something like this ...
 
 ```
-{ 
+{
   :method => "<PAYMENT_METHOD>",
   :status => "<PAYMENT_STATUS>",
   :merchant_reference => "<MERCHANT_REFERENCE>",
@@ -226,7 +234,7 @@ updates) and finally, it's upto you to send the `:response` back to pesapal. The
 hard part is done for you.
 
 ```
-{ 
+{
   :status => "<PAYMENT_STATUS>",
   :response => "<IPN_RESPONSE>"
 }
@@ -289,3 +297,4 @@ they want as long as they provide attribution and waive liability.
 [18]: http://developer.pesapal.com/how-to-integrate/step-by-step
 [19]: https://github.com/itsmrwave/pesapal-rubygem/graphs/contributors
 [20]: http://guides.rubyonrails.org/
+[21]: https://github.com/itsmrwave/pesapal-rubygem/blob/master/CHANGELOG.md#changelog

data/lib/generators/templates/pesapal.rb

@@ -1,7 +1,2 @@
-# Load Pesapal config file when applicatin is loaded ... the config can then be
-# accessed from PesapalRails::Application.config.yaml
-module PesapalRails
-    class Application < Rails::Application
-        config.yaml = YAML::load(IO.read("#{Rails.root}/config/pesapal.yml"))
-    end
-end
+# Load Pesapal config file from YAML file when applicatin is loaded
+Pesapal.config = YAML::load(IO.read("#{Rails.root}/config/pesapal.yml"))

data/lib/pesapal.rb

@@ -1,5 +1,6 @@
 require "rails"
 require "htmlentities"
+require "pesapal/configuration"
 require "pesapal/merchant"
 require "pesapal/merchant/details"
 require "pesapal/merchant/post"

data/lib/pesapal/configuration.rb

@@ -0,0 +1,15 @@
+module Pesapal
+
+  # Returns our config hash, or if empty, returns an empty hash
+  def config
+    @@config ||= {}
+  end
+
+  # Sets our config class variable, which we expect to be a hash
+  def config=(hash)
+    @@config = hash
+  end
+
+  # Allows us to use instance methods on a Module e.g. Pesapal.config
+  module_function :config, :config=
+end

data/lib/pesapal/merchant.rb

@@ -5,11 +5,11 @@ module Pesapal
         attr_accessor :config, :order_details
 
         def config
-            @config
+            @config ||= {}
         end
 
         def order_details
-            @order_details
+            @order_details ||= {}
         end
 
         private
@@ -50,12 +50,9 @@ module Pesapal
 
                 set_mode mode
 
-                # set the credentials if we have not set a custom path for the YAML config file
-                if path_to_file.nil?
-                    # no path to file so no YAML override so we load from initializer
-                    set_configuration PesapalRails::Application.config.yaml[@mode]
-                else
-                    # we have custom path so we load from file
+                # set the credentials if we have specified a path from which we
+                # will access a YAML file with the configurations
+                unless path_to_file.nil?
                     set_configuration_from_yaml path_to_file
                 end
 
@@ -64,6 +61,11 @@ module Pesapal
             # generate pesapal order url (often iframed)
             def generate_order_url
 
+                # check if the config is empty, if yes, we try load what was set by the initializer into Pesapal.config
+                if config.empty?
+                    set_configuration Pesapal.config[@mode]
+                end
+
                 # build xml with input data, the format is standard so no editing is
                 # required
                 @post_xml = Pesapal::Post::generate_post_xml @order_details
@@ -83,6 +85,11 @@ module Pesapal
             # query the details of the transaction
             def query_payment_details(merchant_reference, transaction_tracking_id)
 
+                # check if the config is empty, if yes, we try load what was set by the initializer into Pesapal.config
+                if config.empty?
+                    set_configuration Pesapal.config[@mode]
+                end
+
                 # initialize setting of @params (oauth_signature left empty)
                 @params = Pesapal::Details::set_parameters(@config[:consumer_key], merchant_reference, transaction_tracking_id)
 
@@ -105,7 +112,12 @@ module Pesapal
 
             # query the status of the transaction
             def query_payment_status(merchant_reference, transaction_tracking_id = nil)
-                
+
+                # check if the config is empty, if yes, we try load what was set by the initializer into Pesapal.config
+                if config.empty?
+                    set_configuration Pesapal.config[@mode]
+                end
+
                 # initialize setting of @params (oauth_signature left empty)
                 @params = Pesapal::Status::set_parameters(@config[:consumer_key], merchant_reference, transaction_tracking_id)
 
@@ -125,7 +137,7 @@ module Pesapal
 
             # set mode when called
             def set_mode(mode = :development)
-                
+
                 # convert symbol to string and downcase
                 @mode = "#{mode.to_s.downcase}"
 
@@ -135,7 +147,7 @@ module Pesapal
 
             # listen to ipn response
             def ipn_listener(notification_type, merchant_reference, transaction_tracking_id)
-                
+
                 status = query_payment_status(merchant_reference, transaction_tracking_id)
 
                 output = { :status => status }

data/lib/pesapal/merchant/details.rb

@@ -1,14 +1,14 @@
 module Pesapal
 
     module Details
-        
+
         # set parameters required by the QueryPaymentDetails call
         def Details.set_parameters(consumer_key, merchant_reference, transaction_tracking_id)
 
             # parameters required by the QueryPaymentDetails call (excludes
             # oauth_signature parameter as per the instructions here
             # http://developer.pesapal.com/how-to-integrate/api-reference#QueryPaymentDetails)
-            
+
             timestamp = Time.now.to_i.to_s
 
             params = { :oauth_consumer_key => consumer_key,

data/lib/pesapal/merchant/post.rb

@@ -4,7 +4,7 @@ module Pesapal
 
         # build html encoded xml string for PostPesapalDirectOrderV4
         def Post.generate_post_xml(details)
-            
+
             # build xml with input data, the format is standard so no editing is
             # required
             post_xml = ''
@@ -28,14 +28,14 @@ module Pesapal
 
             "#{post_xml}"
         end
-        
+
         # set parameters required by the PostPesapalDirectOrderV4 call
         def Post.set_parameters(callback_url, consumer_key, post_xml)
 
             # parameters required by the PostPesapalDirectOrderV4 call (excludes
             # oauth_signature parameter as per the instructions here
             # http://developer.pesapal.com/how-to-integrate/api-reference#PostPesapalDirectOrderV4)
-            
+
             timestamp = Time.now.to_i.to_s
 
             params = { :oauth_callback => callback_url,

data/lib/pesapal/merchant/status.rb

@@ -1,14 +1,14 @@
 module Pesapal
 
     module Status
-        
+
         # set parameters required by the QueryPaymentStatus & QueryPaymentStatusByMerchantRef calls
         def Status.set_parameters(consumer_key, merchant_reference, transaction_tracking_id = nil)
 
             # parameters required by the QueryPaymentStatus call (excludes
             # oauth_signature parameter as per the instructions here
             # http://developer.pesapal.com/how-to-integrate/api-reference)
-            
+
             timestamp = Time.now.to_i.to_s
 
             params = { :oauth_consumer_key => consumer_key,

data/lib/pesapal/oauth.rb

@@ -25,7 +25,7 @@ module Pesapal
             # parameters are sorted by name, using lexicographical byte value
             # ordering
             queries.sort!
-            
+
             queries.join('&')
         end
 
@@ -57,7 +57,7 @@ module Pesapal
             # for pesapal flow we don't have a token secret to we will set as
             # nil and the appropriate action will be taken as per the oauth
             # spec. see notes in the method that creates signing keys
-            
+
             # prepare the values we need
             digest = OpenSSL::Digest::Digest.new('sha1')
             signature_base_string = self.generate_signature_base_string(http_method, absolute_url, params)
@@ -144,7 +144,7 @@ module Pesapal
             # unless specified, url scheme and authority must be lowercase and
             # include the port number; http default port 80 and https default
             # port 443 must be excluded.
-          
+
             u = URI.parse(absolute_url)
 
             scheme = u.scheme.downcase

data/lib/pesapal/version.rb

@@ -1,3 +1,3 @@
 module Pesapal
-    VERSION = "1.2.0"
+    VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pesapal
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Job King'ori Maina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - lib/generators/templates/pesapal.rb
 - lib/generators/templates/pesapal.yml
 - lib/pesapal.rb
+- lib/pesapal/configuration.rb
 - lib/pesapal/merchant.rb
 - lib/pesapal/merchant/details.rb
 - lib/pesapal/merchant/post.rb