trustly-client-ruby 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca9ff0abd3eadbde9d7ada98e1c25507e00fa534
-  data.tar.gz: 03cc19c4253d50be02ee4db20903f17a050fa366
+  metadata.gz: 20e58d7cb248d8adfa149f89eaba36b8bfe9c520
+  data.tar.gz: 71ef2a4aeef7e028b8054387fa72055cb7fdff0a
 SHA512:
-  metadata.gz: e75d6fdd5131303f9eb378f9bf908045f5ebcae42c50fde53e518c0dc5a0fdf2d63ac7641d113f4e2b7f9075ea28f208e1ae21b55d620adba43fe7a495ea6e4c
-  data.tar.gz: 11df02b98fe608c64eec1bb883f47f2996ece22a457b9931a5f7f0704667e9d7589fa5c1a408b2d91f1941e7b692164ed92516fe844dc448da36b057f1a406a4
+  metadata.gz: 547c1f23f5a1564f0c575bf7a3cbf0a76df3a46e850b0c3d3e290122ebdda9774b1328a03c91b9494dce20c6772b340a694420305e0c2ea6a749f5446633b82d
+  data.tar.gz: 5784007b972a3af3ef8febe82b93490985067490a3ee3f945654ae711c562f437b3da398653132cbe265f3f8a1c79185a869a18fc483566df00e07e0d343d07a

data/README.md

@@ -1,38 +1,176 @@
-# Trustly::Client::Ruby
+# Trustly-client-ruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/trustly/client/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is an example implementation of communication with the Trustly API using Ruby. This a ruby gem that allows you use Trustly Api calls in ruby. It's based on [trustly-client-python] (https://github.com/trustly/trustly-client-python) and [turstly-client-php] (https://github.com/trustly/trustly-client-php)
+
+It implements the standard Payments API as well as gives stubs for executing calls against the API used by the backoffice.
+
+For full documentation on the Trustly API internals visit our developer website: http://trustly.com/developer . All information about software flows and call patters can be found on that site. The documentation within this code will only cover the code itself, not how you use the Trustly API.
+
+This code is provided as-is, use it as inspiration, reference or drop it directly into your own project and use it.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'trustly-client-ruby'
+gem 'trustly-client-ruby',:require=>'trustly'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install trustly-client-ruby
 
+If you use rails, you can use this generator in order to let trustly find your certificates:
+
+    $ rails g trustly:install
+
+This will copy trustly public certificates under certs/trustly folder:
+    
+    certs/trustly/test.trustly.public.pem
+    certs/trustly/live.trustly.public.pem
+
+You will need to copy test and live private certificates using this naming convention (if you want Trustly to load them automatically but you can use different path and names):
+
+    certs/trustly/test.merchant.private.pem
+    certs/trustly/live.merchant.private.pem 
+
 ## Usage
 
-TODO: Write usage instructions here
+Currently only **Deposit** and **Refund** api calls. However, other calls can be implemented very easily.
+
+### Api
+
+In order to use Trustly Api, we'll need to create a **Trustly::Api::Signed**. Example:
+
+```ruby
+api = Trustly::Api::Signed.new({
+	:username=>"yourusername",
+	:password=>"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+})
+```
+
+This will automatically load pem files from **certs/trustly** with default optons. If you want to specify other paths or options then you can call:
+
+```ruby
+api = Trustly::Api::Signed.new({
+	 :username=>"yourusername",
+	 :password=>"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    :host        => 'test.trustly.com',
+    :port        => 443,
+    :is_https    => true,
+    :private_pem => "#{Rails.root}/certs/trustly/test.merchant.private.pem",
+    :public_pem  => "#{Rails.root}/certs/trustly/test.trustly.public.pem"
+})
+```
+
+### Deposit call
+
+Deposit is straightfoward call. Only required arguments example:
+
+```ruby
+deposit = api.deposit({"EndUserID"=>10002,"MessageID"=>12349,"Amount"=>3})
+```
+Optional arguments are:
+
+- Locale:  default value "es_ES"
+- Country: default "ES"
+- Currency default "EUR"
+- SuggestedMinAmount
+- SuggestedMaxAmount
+- Amount
+- Currency
+- Country
+- IP
+- SuccessURL: default "https://www.trustly.com/success"
+- FailURL   : default "https://www.trustly.com/fail"
+- TemplateURL
+- URLTarget
+- MobilePhone
+- Firstname
+- Lastname
+- NationalIdentificationNumber
+- ShopperStatement
+- NotificationURL: default "https://test.trustly.com/demo/notifyd_test"
+
+This will return a **Trustly::Data::JSONRPCResponse**:
+
+```ruby
+> deposit.get_data('url')
+=> "https://test.trustly.com/_/orderclient.php?SessionID=755ea475-dcf1-476e-ac70-07913501b34e&OrderID=4257552724&Locale=es_ES"
+
+> deposit.get_data()
+=> {
+	"orderid" => "4257552724", 
+	"url"     => "https://test.trustly.com/_/orderclient.php?SessionID=755ea475-dcf1-476e-ac70-07913501b34e&OrderID=4257552724&Locale=es_ES"
+}
+```
+
+You can check if there was an error:
+
+```ruby
+> deposit.error?
+=> true
+
+> deposit.success?
+=> false
+
+> deposit.error_msg
+=> "ERROR_DUPLICATE_MESSAGE_ID"
+```
+
+### Refund call
+
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+### Notifications
+
+After a **deposit** or **refund** call, Trustly will send a notification to **NotificationURL**. If you are using rails the execution flow will look like this:
+
+```ruby
+def controller_action
+	api = Trustly::Api::Signed.new({..}) 
+	notification = Trustly::JSONRPCNotificationRequest.new(params)
+	if api.verify_trustly_signed_notification(notification)
+	   # do something with notification
+	   ...
+	   # reply to trustly
+	   response = api.notification_response(notification,true)
+	   render :text => response.json()
+	else
+		render :nothing => true, :status => 200
+	end
+end
+``` 
+
+You can use **Trustly::JSONRPCNotificationRequest** object to access data provided using the following methods:
+
+```ruby
+ notification.get_data
+=> {"amount"=>"902.50", "currency"=>"EUR", "messageid"=>"98348932", "orderid"=>"87654567", "enduserid"=>"32123", "notificationid"=>"9876543456", "timestamp"=>"2010-01-20 14:42:04.675645+01", "attributes"=>{}}
+
+> notification.get_method
+=> "credit"
+
+> notification.get_uuid
+=> "258a2184-2842-b485-25ca-293525152425"
+
+> notification.get_signature
+=> "R9+hjuMqbsH0Ku ... S16VbzRsw=="
+
+> notification.get_data('amount')
+=> "902.50"
+```
+
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/trustly-client-ruby/fork )
+1. Fork it ( https://github.com/jcarreti/trustly-client-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/generators/trustly/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module Trustly
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Create cert folder and trustly pem files'
+      source_root ::File.expand_path('../templates', __FILE__)
+
+      def copy_files
+        copy_file "test.trustly.public.pem", "certs/trustly/test.trustly.public.pem"
+        copy_file "live.trustly.public.pem", "certs/trustly/live.trustly.public.pem"
+      end
+
+    end
+  end
+end

data/lib/generators/trustly/templates/live.trustly.public.pem

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoZhnqiELeoX3QNSg7jpU
+kbLV4BU32LoSMuABAaPdxhpZaccFYud2z4QUlMq/j46vdVDpaCFaCZ+qNT5+tHbQ
+BFgcrx82u7r+aMHvKy4FEczT5aev0NxRlQKHmNQygvp3hNkqeOw4nJy3PoD4cgCp
+SlLTiPOBy2ZsWUHQpSVJdDUiLwAQfNV90jMqa3zq1nTfmTBmd6NR1XAjg5eS6SWr
+to1nVS1b7XKGv7Cc1kt0RVd54tWqoCMDHwEiU0st66BCKdYk3r5woDZxGZUUjVdm
+g9O2xpqRRDcdJGm8HIOVHGSNT9R7LMucH/PGwrfpdWmBDjy0BkuDlssuBgh731l2
+cwIDAQAB
+-----END PUBLIC KEY-----

data/lib/generators/trustly/templates/test.trustly.public.pem

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAy7h/yX8DEA2m588SrWye
+AC8rTMbErwHt2hoTiP9fte/iOo0FXIZSmNsNu422L+iJyvZQu19ebeL7XgB0UXqt
+zA6KtXBMXIKwuMCZhbdeR8sb7OKbX2nlWM+e2Hmrr9CTfkZkFBeSC+iN9fAU6PoR
+X0i5PWm0uZnaoWXcZnk5CxQCgnfYgsx7xsd8Au+mrqE8SHeT8zi/Inw0Xp6ba25G
+YsZhHfIPD2rcZQOpWbmHRS4Jk4aGzSOBHbAZhKlP97PxoVfUcPI3iCA1+3jMs1l2
+PYsHUbP60NMVwkGPjFOTv4m1a1wKsue0mhspDdvswZUeKE+POGOuewqTQJ+gIhXw
+mQIDAQAB
+-----END PUBLIC KEY-----

data/lib/trustly.rb

@@ -13,8 +13,8 @@ require "trustly/data/request"
 require "trustly/data/response"
 require "trustly/data/jsonrpc_request"
 require "trustly/data/jsonrpc_response"
-require "trustly/data/jsonrpcnotificationrequest"
-require "trustly/data/jsonrpcnotificationrequest"
+require "trustly/data/jsonrpcnotification_request"
+require "trustly/data/jsonrpcnotification_response"
 
 require "trustly/api"
 require "trustly/api/signed"

data/lib/trustly/api.rb

@@ -46,6 +46,14 @@ class Trustly::Api
     raise NotImplementedError
   end
 
+  def verify_trustly_signed_notification(response)
+    method    = response.get_method()
+    uuid      = response.get_uuid()
+    signature = response.get_signature()
+    data      = response.get_data()
+    return self._verify_trustly_signed_data(method, uuid, signature, data)
+  end
+
   protected
 
   def _verify_trustly_signed_data(method, uuid, signature, data)
@@ -64,13 +72,6 @@ class Trustly::Api
     return self._verify_trustly_signed_data(method, uuid, signature, data)
   end
 
-  def verify_trustly_signed_notification(response)
-    method    = response.get_method()
-    uuid      = response.get_uuid()
-    signature = response.get_signature()
-    data      = response.get_data()
-    return self._verify_trustly_signed_data(method, uuid, signature, data)
-  end
 
   def set_host(host=nil,port=nil,is_https=nil)
     self.api_host = host          unless host.nil?

data/lib/trustly/api/signed.rb

@@ -8,7 +8,7 @@ class Trustly::Api::Signed < Trustly::Api
       :host        => 'test.trustly.com',
       :port        => 443,
       :is_https    => true,
-      :private_pem => "#{Rails.root}/certs/trustly/test.acuerdalo.private.pem",
+      :private_pem => "#{Rails.root}/certs/trustly/test.merchant.private.pem",
       :public_pem  => "#{Rails.root}/certs/trustly/test.trustly.public.pem"
     }.merge(_options)
 
@@ -110,6 +110,24 @@ class Trustly::Api::Signed < Trustly::Api
     #options["HoldNotifications"] = "1" unless 
   end
 
+  def refund(_options)
+    options = {
+      "OrderID" => "EUR"
+    }.merge(_options)
+
+    # check for required options
+    ["OrderID","Amount","Currency"].each{|req_attr| raise Trustly::Exception::DataError, "Option not valid '#{req_attr}'" if options.try(:[],req_attr).nil? }
+
+    request = Trustly::Data::JSONRPCRequest.new('Deposit',options,nil)
+    return self.call_rpc(request)
+  end
+
+  def notification_response(notification,success=true)
+    response = Trustly::JSONRPCNotificationResponse.new(notification,success)
+    response.set_signature(self.sign_merchant_request(notification))
+    return notification
+  end
+
   def withdraw(_options)
 
   end

data/lib/trustly/data/{jsonrpcnotificationrequest.rb → jsonrpcnotification_request.rb}

@@ -3,15 +3,19 @@ class Trustly::JSONRPCNotificationRequest < Trustly::Data
   attr_accessor :notification_body, :payload
 
   def initialize(notification_body)
-    super
+    super()
     self.notification_body = notification_body
-    begin
-      self.payload = JSON.parse(self.notification_body)
-    rescue JSON::ParserError => e 
-      raise Trustly::Exception::DataError, e.message
+    unless self.notification_body.is_a?(Hash)
+      begin
+        self.payload = JSON.parse(self.notification_body)
+      rescue JSON::ParserError => e 
+        raise Trustly::Exception::DataError, e.message
+      end
+
+      raise Trustly::Exception::JSONRPCVersionError, 'JSON RPC Version #{(self.get_version()} is not supported' if self.get_version() != '1.1'
+    else
+      self.payload = self.notification_body.deep_stringify_keys
     end
-
-    raise Trustly::Exception::JSONRPCVersionError, 'JSON RPC Version #{(self.get_version()} is not supported' if self.get_version() != '1.1'
   end
 
   def get_version()

data/lib/trustly/version.rb

@@ -1,3 +1,3 @@
 module Trustly
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trustly-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Jorge Carretie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -46,15 +46,17 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- lib/generators/trustly/install_generator.rb
+- lib/generators/trustly/templates/live.trustly.public.pem
+- lib/generators/trustly/templates/test.trustly.public.pem
 - lib/trustly.rb
-- lib/trustly.rb~
 - lib/trustly/api.rb
 - lib/trustly/api/signed.rb
 - lib/trustly/data.rb
 - lib/trustly/data/jsonrpc_request.rb
 - lib/trustly/data/jsonrpc_response.rb
-- lib/trustly/data/jsonrpcnotificationrequest.rb
-- lib/trustly/data/jsonrpcnotificationresponse.rb
+- lib/trustly/data/jsonrpcnotification_request.rb
+- lib/trustly/data/jsonrpcnotification_response.rb
 - lib/trustly/data/request.rb
 - lib/trustly/data/response.rb
 - lib/trustly/exception.rb
@@ -64,7 +66,6 @@ files:
 - lib/trustly/exception/jsonrpc_version_error.rb
 - lib/trustly/exception/signature_error.rb
 - lib/trustly/version.rb
-- lib/trustly/version.rb~
 homepage: https://github.com/jcarreti/trusty-client-ruby
 licenses:
 - MIT

data/lib/trustly.rb~

@@ -1,19 +0,0 @@
-module Trustly
-end
-
-require "trustly/exception/authentification_error"
-require "trustly/exception/connection_error"
-require "trustly/exception/data_error"
-require "trustly/exception/jsonrpc_version_error"
-require "trustly/exception/signature_error"
-
-require "trustly/data"
-require "trustly/data/jsonrpc_request"
-require "trustly/data/jsonrpc_response"
-require "trustly/data/jsonrpcnotificationrequest"
-require "trustly/data/jsonrpcnotificationrequest"
-
-require "trustly/api"
-require "trustly/api/signed"
-require "trustly/version"
-

data/lib/trustly/version.rb~

@@ -1,3 +0,0 @@
-module Trustly
-  VERSION = "0.1.6"
-end