pesapal 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44aef97bfcafb5b7ce0a7db59a613eccb7dbacd7
-  data.tar.gz: 87b26cead15de174dffe376207ba2c788483b38a
+  metadata.gz: 8166e77a88a3f62b22458f737b9342b1750aa18d
+  data.tar.gz: d95d4174f1b2b324b08c9a3a611d7a187e915d05
 SHA512:
-  metadata.gz: 47c85fc5ae2a65a9158bda4ec6966ea0ddd3836e8d0e2a3fc9d223e3aef8780a82c8473beb8e7881a85c1eb9dfe99e08304c6c7fa6a403e127129e97465904a9
-  data.tar.gz: 59e945655938a5a6def127f44eae00c4c3b75727348e43602605495a98bdbd0fb7cf635e24e0523c5bdbc4abb7505bac7d5b41bd87309a5fff384f319d7bf2e5
+  metadata.gz: 23618f43a0a739ff6871a1f1dba80324b6cad7de1f8006c13c651708792c3d7ba2d3fdea0f608a10e95a3fef8b5d4c52c16ca10e494da704bce922dbef6159e9
+  data.tar.gz: a833ad55d35d4c83b736ec708d4e4e4762565ca1d0d2a044059d099b4ef7479c0b54b26e33d370cf555e81140fd64a62791937fd1feda9aa61b9502a85103a15

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+Changelog
+=========
+
+v0.2.0
+------
+
+* Fix syntax error, and incorrect config hash name
+* Add pesapal config file generator
+* Move loading YAML config to initializer instead of each time the object is initialized
+
+v0.1.0
+------
+
+* Add configuration with YAML file functionality, fall back to default, previous method still applies
+* Move callback details to config hash (breaking change)
+
+v0.0.3
+------
+
+* Fix screwed up the specifying of dependencies
+
+v0.0.2
+------
+
+* Add dependencies htmlentities
+* Update homepage url in rubygem
+* Update to README
+
+v0.0.1
+------
+
+Initial release, kind of a proof of concept ... by v1.0.0 we should have a
+version ready for deployment in production environment and having all those
+other features that should be there at bare minimum such IPN stuff and all. Also
+by then, the demo (in rails) should have been complete.
+
+* Transparently handles authentication on API calls
+* Has method to generate post-order-url with ease i.e. that url that has the various payment options and whatnot

data/README.md

@@ -40,6 +40,10 @@ Or install it yourself as:
 
     $ gem install pesapal
 
+For Rails, you need to run the generator to set up some necessary stuff:
+
+    rails generate pesapal:install
+
 
 Usage
 -----
@@ -56,19 +60,22 @@ with the testing or the live Pesapal API.
 pesapal = Pesapal::Merchant.new(:development)
 ```
 
-You can set the configuration details from a YAML file at the location of
-your choice upon initialization as shown in the example below for a Rails app.
-The second parameter is optional and has a default value of
-`"#{Rails.root}/config/pesapal.yml"` if left out as in the example above.
+You can set the configuration details from a YAML file at the location of your
+choice upon initialization as shown in the example below for a Rails app. The
+second parameter is optional and has a default value of
+`"#{Rails.root}/config/pesapal.yml"` if left out as in the example above. In
+this case, please note that this YAML file is only loaded when your application
+starts and not everytime an object is initialized.
 
 ```ruby
 # initiate pesapal object set to development mode and use the YAML file found at
-# the specified location
+# the specified location ... this overrides and loads the YAML file afresh
 pesapal = Pesapal::Merchant.new(:development, "<PATH_TO_YAML_FILE>")
 ```
 
-And the YAML file should look something like this. Feel free to change to the
-appropriate values.
+The YAML file should look something like this. If you ran the generator you
+should have it already in place with some default values. Feel free to change
+them appropriately.
 
 ```yaml
 development:
@@ -153,12 +160,15 @@ Contributing
 4. Push to the branch (`git push origin BRANCH_NAME`)
 5. Create new pull request and we can [have the conversations here][17]
 
+_Ps: See [current contributors][19]._
+
 
 References
 ----------
 
 * [oAuth 1.0 Spec][1]
 * [Developing a RubyGem using Bundler][2]
+* [RailsGuides][20]
 * [Make your own gem][3]
 * [Pesapal API Reference (Official)][4]
 * [Pesapal Step-By-Step Reference (Official)][18]
@@ -190,3 +200,5 @@ they want as long as they provide attribution and waive liability.
 [16]: http://kingori.co/articles/2013/09/modus-operandi/
 [17]: https://github.com/itsmrwave/pesapal-rubygem/pulls
 [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/

data/lib/generators/pesapal/install_generator.rb

@@ -0,0 +1,21 @@
+module Pesapal
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Pesapal config file to your application."
+
+      def copy_config
+        copy_file "pesapal.yml", "config/pesapal.yml"
+      end
+
+      def copy_initializer
+        copy_file "pesapal.rb", "config/initializers/pesapal.rb"
+      end
+
+      def show_readme
+        readme "README.md" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README.md

@@ -0,0 +1,21 @@
+
+How To Use Config File
+----------------------
+
+The Pesapal config file is in YAML format and looks something like this. Change
+the values appropriately.
+
+```
+development:
+    callback_url: 'http://0.0.0.0:3000/pesapal/callback'
+    consumer_key: '<YOUR_CONSUMER_KEY>'
+    consumer_secret: '<YOUR_CONSUMER_SECRET>'
+
+production:
+    callback_url: 'http://1.2.3.4:3000/pesapal/callback'
+    consumer_key: '<YOUR_CONSUMER_KEY>'
+    consumer_secret: '<YOUR_CONSUMER_SECRET>'
+```
+
+The config file can be found at `#{Rails.root}/config/pesapal.yml`.
+

data/lib/generators/templates/pesapal.rb

@@ -0,0 +1,7 @@
+# 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

data/lib/generators/templates/pesapal.yml

@@ -0,0 +1,9 @@
+development:
+    callback_url: 'http://0.0.0.0:3000/pesapal/callback'
+    consumer_key: '<YOUR_CONSUMER_KEY>'
+    consumer_secret: '<YOUR_CONSUMER_SECRET>'
+
+production:
+    callback_url: 'http://1.2.3.4:3000/pesapal/callback'
+    consumer_key: '<YOUR_CONSUMER_KEY>'
+    consumer_secret: '<YOUR_CONSUMER_SECRET>'

data/lib/pesapal.rb

@@ -1,3 +1,4 @@
+require "rails"
 require "htmlentities"
 require "pesapal/merchant"
 require "pesapal/merchant/post"

data/lib/pesapal/merchant.rb

@@ -1,5 +1,5 @@
 module Pesapal
-    
+
     class Merchant
 
         attr_accessor :config, :order_details
@@ -42,7 +42,7 @@ module Pesapal
         public
 
             # constructor
-            def initialize(mode = :development, path_to_file = "#{Rails.root}/config/pesapal.yml")
+            def initialize(mode = :development, path_to_file = nil)
 
                 # initialize
                 @params = nil
@@ -52,8 +52,14 @@ module Pesapal
                 # convert symbol to string and downcase
                 @mode = "#{mode.to_s.downcase}"
 
-                # set the credentials
-                set_configuration_from_yaml path_to_file
+                # 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_configuration_from_yaml path_to_file
+                end
 
                 # set api endpoints depending on the mode
                 set_endpoints
@@ -67,10 +73,10 @@ module Pesapal
                 @post_xml = Pesapal::Post::generate_post_xml @order_details
 
                 # initialize setting of @params (oauth_signature left empty) ... this gene
-                @params = Pesapal::Post::set_parameters(@credentials[:callback_url], @credentials[:consumer_key], @post_xml)
+                @params = Pesapal::Post::set_parameters(@config[:callback_url], @config[:consumer_key], @post_xml)
 
                 # generate oauth signature and add signature to the request parameters
-                @params[:oauth_signature] = Pesapal::Oauth::generate_oauth_signature("GET", @api_endpoints[:postpesapaldirectorderv4], @params, @credentials[:consumer_secret], @token_secret)
+                @params[:oauth_signature] = Pesapal::Oauth::generate_oauth_signature("GET", @api_endpoints[:postpesapaldirectorderv4], @params, @config[:consumer_secret], @token_secret)
 
                 # change params (with signature) to a query string
                 query_string = Pesapal::Oauth::generate_encoded_params_query_string @params
@@ -100,9 +106,9 @@ module Pesapal
             def set_configuration(consumer_details = {})
 
                 # set the configuration
-                @config = { :callback_url => 'http://0.0.0.0:3000/pesapal/callback'
+                @config = { :callback_url => 'http://0.0.0.0:3000/pesapal/callback',
                             :consumer_key => '<YOUR_CONSUMER_KEY>',
-                            :consumer_secret => '<YOUR_CONSUMER_SECRET>' 
+                            :consumer_secret => '<YOUR_CONSUMER_SECRET>'
                         }
 
                 valid_config_keys = @config.keys
@@ -133,7 +139,7 @@ module Pesapal
 
                     # in this case default values will be set
                     set_configuration
-                end 
+                end
             end
     end
 end

data/lib/pesapal/version.rb

@@ -1,3 +1,3 @@
 module Pesapal
-    VERSION = "0.1.0"
+    VERSION = "0.2.1"
 end

data/pesapal.gemspec

@@ -5,7 +5,7 @@ require "pesapal/version"
 Gem::Specification.new do |spec|
     spec.name          = "pesapal"
     spec.version       = Pesapal::VERSION
-    spec.date          = "2013-10-01"
+    spec.date          = "2013-10-13"
     spec.authors       = ["Job King'ori Maina"]
     spec.email         = ["j@kingori.co"]
     spec.description   = "Make authenticated Pesapal API calls without the fuss!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pesapal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Job King'ori Maina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,10 +60,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/pesapal/install_generator.rb
+- lib/generators/templates/README.md
+- lib/generators/templates/pesapal.rb
+- lib/generators/templates/pesapal.yml
 - lib/pesapal.rb
 - lib/pesapal/merchant.rb
 - lib/pesapal/merchant/post.rb
@@ -90,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.1.8
 signing_key: 
 specification_version: 4
 summary: Make authenticated Pesapal API calls without the fuss! Handles all the oAuth