allorails 0.3.1 → 0.3.2

data/Manifest

@@ -1,6 +1,5 @@
 README.md
 Rakefile
-allorails.gemspec
 init.rb
 lib/allorails.rb
 lib/allorails/api/api.rb

data/README.md

@@ -1,7 +1,69 @@
-*IMPORTANT:* Allorails is still being developed and tested. Use at your own risk ;)
+# Allorails
 
-## Allorails
+Allorails is a Ruby client for Allopass's online payment REST API. It allows Ruby and Rails developers to easily integrate their software with the Allopass online payment platform.
 
-Allorails is a Ruby gem which allows to interact with Allopass's online payment REST API.
+### Setup
 
-It is a Ruby port of the Allopass ApiKit for Python written by Pierre Geoffroy and available [here](http://developer.allopass.com/apidoc/kit/python3.1/index.html). 
+Despite the name, Allorails *does not* require Rails, and can be used just like any ordinary Ruby gem:
+
+    gem install allorails
+
+will install the `allorails` gem on your system. You can then `require "allorails"` from your Ruby code, which makes the `Allorails` class available.
+
+**Rails users**, you can simply add the following line to your `Gemfile`
+
+    gem allorails
+
+### Configuration
+
+You can provide configuration options to Allorails by calling `Allorails.config` :
+
+    Allorails.config({
+      :accounts => {
+        :'your@account.email' => {
+          :api_key => 'your-allopass-api-key',
+          :private_key => 'your-allopass-private-key'
+        }
+      }
+    })
+    
+**Rails users**: you can put the above code in an initializer, e.g. `config/initializers/allorails.rb`, or use the `allorails.yml` configuration method explained below.
+    
+**Multiple accounts** can be set up by adding other email addresses to the `:accounts` hash.
+
+### Usage
+
+Now that the configuration is done, let's start using the API:
+
+    api = Allorails::Api.new
+    response = api.get_onetime_pricing({'site_id' => YOUR_SITE_ID, 'country' => 'UK'})
+    puts response.creation_date
+    
+If you have set up multiple accounts, you can choose which one to use by passing the email address to Api.new: `Allorails::Api.new('your@account.email')`
+
+### Rails users: `allorails.yml` configuration file
+
+You can put your configuration options in a yaml file located at `config/allorails.yml`. This file must have the same structure as the standard `database.yml` file found in all Rails applications, i.e. it must include a key for each environment:
+
+    development:
+      accounts:
+        your@account.email:
+          api_key: "YOUR_API_KEY"
+          private_key: "YOUR_PRIVATE_KEY" 
+      
+      # optional settings
+      # (the values below are the defaults)
+      default_hash: "sha1"
+      default_format: "json"
+      network_timeout: 20
+      network_protocol: "http"
+      network_port: 80
+      host: "api.allopass.com"
+
+    
+    
+    
+    
+### Credits
+
+Allorails is inspired by the Allopass ApiKit for Python written by Pierre Geoffroy and available [here](http://developer.allopass.com/apidoc/kit/python3.1/index.html). 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('allorails', '0.3.1') do |p|
+Echoe.new('allorails', '0.3.2') do |p|
   p.description    = "Ruby client for the Allopass online payment REST API"
   p.url            = "http://github.com/davb/allorails"
   p.author         = "Davide Bonapersona"

data/allorails.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "allorails"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Davide Bonapersona"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = "Ruby client for the Allopass online payment REST API"
   s.email = "davide@feeligo.com"
   s.extra_rdoc_files = ["README.md", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/model.rb", "lib/allorails/response/response.rb"]
-  s.files = ["README.md", "Rakefile", "allorails.gemspec", "init.rb", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/model.rb", "lib/allorails/response/response.rb", "test/allorails_spec.rb", "test/test-conf-sample.yml", "test/test-conf.yml", "Manifest"]
+  s.files = ["README.md", "Rakefile", "init.rb", "lib/allorails.rb", "lib/allorails/api/api.rb", "lib/allorails/core.rb", "lib/allorails/errors/errors.rb", "lib/allorails/rails.rb", "lib/allorails/request/request.rb", "lib/allorails/response/model.rb", "lib/allorails/response/response.rb", "test/allorails_spec.rb", "test/test-conf-sample.yml", "test/test-conf.yml", "Manifest", "allorails.gemspec"]
   s.homepage = "http://github.com/davb/allorails"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Allorails", "--main", "README.md"]
   s.require_paths = ["lib"]

data/lib/allorails/request/request.rb

@@ -38,7 +38,7 @@ module Allorails
       #  @param emailAccount (string) Configurated email account
       def initialize(parameters, mapping = true, email_account = nil)
         @_mapping = mapping
-        @_parameters = parameters
+        @_parameters = _stringify_symbols parameters
         @_email_account = email_account
       end
 
@@ -55,6 +55,14 @@ module Allorails
           return Allorails::Response::ApiResponse.new(signature, headers, body)
         end
       end
+      
+      # Internal method to turn symbols (keys and values) into strings
+      def _stringify_symbols x
+        return x.to_s if x.is_a?(Symbol)
+        return x.map{|y| _stringify_symbols y} if x.is_a?(Array)
+        return x.inject({}) {|h, (k,v)| h[_stringify_symbols k] = _stringify_symbols v; h} if x.is_a?(Hash)
+        return x
+      end
 
       ## Internal method building special required API parameters
       #

data/lib/allorails/response/response.rb

@@ -123,7 +123,7 @@ module Allorails
     
       ## Provides the website
       #  @return (Website) website
-      node_reader :website
+      node_reader :website, Website
     
       ## Provides the pricepoints by countries
       #  @return (Array) available countries (list of Country object)
@@ -190,7 +190,7 @@ module Allorails
     
       ## Provides the website
       #  @return (Website) website
-      node_reader :website
+      node_reader :website, Website
     
       ## Provides the customer ip
       #  @return (string) customer ip
@@ -256,7 +256,7 @@ module Allorails
     
       ## Provides the website
       #  @return (Website) website
-      node_reader :website
+      node_reader :website, Website
     
       ## Provides the expected number of codes
       #  @return (int) expected number of codes
@@ -306,7 +306,7 @@ module Allorails
     
       ## Provides the website
       #  @return (Website) website
-      node_reader :website
+      node_reader :website, Website
     
       ## Provides the buy url
       #  @return (string) buy url

data/test/allorails_spec.rb

@@ -31,10 +31,11 @@ end
 
 describe Allorails::Api, "#get_onetime_pricing" do
   api = Allorails::Api.new
-  resp = api.get_onetime_pricing({'site_id' => YOUR_SITE_ID, 'country' => TEST_COUNTRY_CODE})
   it "returns a valid response" do
+    resp = api.get_onetime_pricing({'site_id' => YOUR_SITE_ID, 'country' => TEST_COUNTRY_CODE})
     resp.to_s.should_not be_nil
     resp.creation_date.is_a?(DateTime).should be_true
+    resp.website.is_a?(Allorails::Website).should be_true
     resp.regions.is_a?(Array).should be_true
     resp.regions.each do |reg|
       reg.is_a?(Allorails::Region).should be_true
@@ -45,6 +46,10 @@ describe Allorails::Api, "#get_onetime_pricing" do
       end
     end
   end
+  it "works with symbol keys and values" do
+    resp = api.get_onetime_pricing({:site_id => YOUR_SITE_ID, :country => TEST_COUNTRY_CODE.to_sym})
+    resp.creation_date.is_a?(DateTime).should be_true
+  end
 end
 
 describe Allorails::Api, "#create_discrete_button" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allorails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -28,7 +28,6 @@ extra_rdoc_files:
 files:
 - README.md
 - Rakefile
-- allorails.gemspec
 - init.rb
 - lib/allorails.rb
 - lib/allorails/api/api.rb
@@ -42,6 +41,7 @@ files:
 - test/test-conf-sample.yml
 - test/test-conf.yml
 - Manifest
+- allorails.gemspec
 homepage: http://github.com/davb/allorails
 licenses: []
 post_install_message: