mollie-payment 0.0.2 → 0.1.0

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 .rbenv-gemsets
 .rbenv-version
+.yardoc

data/README.md

@@ -1,9 +1,11 @@
 Mollie Payment
 ========
 
-This repository is currently under [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html); an empty box with no implementation, only a documented interface.
+This repository is currently a work in progress and under [Documentation Driven Development](http://thinkingphp.org/spliceit/docs/0.1_alpha/pages/ddd_info.html).
 
-Documentation uses the [Tomdoc](http://tomdoc.org/) specification. The generated docs can be [found here](http://rubydoc.info/gems/mollie-payment/0.0.2/frames).
+On the one hand to get familiar with documenting and [YARD](http://yardoc.org/). On the other hand to create an opiniated Ruby-wrapper for the Mollie [iDEAL API](https://www.mollie.nl/beheer/betaaldiensten/documentatie/ideal/).
+
+The generated docs can be [found here](http://rubydoc.info/gems/mollie-payment/0.0.2/frames).
 
 Develop
 ------------

data/lib/mollie/ideal/version.rb

@@ -1,5 +1,5 @@
 module Mollie
   class Ideal
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/lib/mollie/ideal.rb

@@ -1,93 +1,89 @@
 module Mollie
   class Ideal
-    # Public: Initialize Ideal
+    # Create a new Ideal object
     #
-    # partner_id - String your Mollie partner id
-    # options - Hash options:
-    #           :test - Boolean use testmode? (default: true)
-    #
-    # Examples
-    #
-    #   mi = Mollie::Ideal.new('123456', :test => false)
-    #
-    def initialize(partner_id, options={:test => true});end
+    # @param [String] partner_id your Mollie partner id
+    # @param [Hash] options
+    # @option options [Boolean] :production (false) whether or not to operate 
+    #   in production-mode
+    def initialize(partner_id, options={:production => false});end
 
-    # Public: All supported banks.
+    # All supported banks.
     #
-    # Examples
+    # @visibility public
     #
-    #   Mollie::Ideal.banklist
+    # @example
+    #   Mollie::Ideal.banks
     #   # => [{:id => '0031', :name => 'ABN AMRO'}, ...]
     #
-    # Returns an Array of Hash representing banks (keys: String id, 
-    # String name).
-    def self.banklist;end
-    def self.banks
-      banklist
-    end
-
-    def banklist
-      self.class.banklist
+    # @return [Array<Hash{Symbol => String}>] the list of banks.
+    def self.banks;end
+    class << self
+      alias :banklist :banks
     end
-    alias :banks :banklist
 
-    # Public: Request a transaction.
+    # Request a transaction.
     #
-    # options - Hash options:
-    #           :amount - Fixnum the amount *in cents*
-    #           :bank_id - String id of the bank
-    #           :description - String description of the transaction (max. 30 
-    #                          characters)
-    #           :report_url - String url where the result of the transaction 
-    #                         is sent
-    #           :return_url - String url where the visitor is sent
-    #           :profile_key - String profile this transaction should be linked
-    #                          to (default: nil)
-    #
-    # Examples
+    # @visibility public
     #
+    # @param [Hash] opts
+    # @option opts [Fixnum] :amount the amount in cents.
+    # @option opts [String] :bank_id the id of the bank (see {banks}).
+    # @option opts [String] :description description of the transaction 
+    #   (max. 30 characters).
+    # @option opts [String] :report_url address where the result of the 
+    #   transaction is sent (POSTed?).
+    # @option opts [String] :return_url address where the visitor is sent.
+    # @option opts [String] :profile_key (nil) the profile this transaction 
+    #   should be linked to.
+    # 
+    # @example
+    #   
     #   mi = Mollie::Ideal.new('12345')  
-    #   mi.fetch(:amount => 1465, :bank_id => '0721',
-    #             :description => "Charlie Brown's Tree", 
-    #             :report_url => 'http://example.org/report',
-    #             :return_url => 'http://example.org/return')
+    #   mi.request_transaction(:amount => 1465, 
+    #                           :bank_id => '0721',
+    #                           :description => "Charlie Brown's Tree", 
+    #                           :report_url => 'http://example.org/report',
+    #                           :return_url => 'http://example.org/return')
     #   # => {
-    #           :transaction_id => '482d599bbcc7795727650330ad65fe9b',
-    #           :amount => 1465,
-    #           :currency => 'EUR',
-    #           :url => 'https://mijn.postbank.nl/...',
-    #         }
+    #   #        :transaction_id => '482d599bbcc7795727650330ad65fe9b',
+    #   #        :amount => 1465,
+    #   #        :currency => 'EUR',
+    #   #        :url => 'https://mijn.postbank.nl/...',
+    #   #      }
     #
-    # Returns a Hash representing the transaction (keys: Fixnum amount, 
-    # String currency, String transaction_id, String url).
-    def fetch(options);end
+    # @return [Hash] the transaction (see example)
+    def request_transaction(opts);end
 
-    # Public: Verify the status of a transaction.
-    #
-    # options - Hash options:
-    #           :transaction_id - String id of the transaction
+    # Verify the status of a transaction.
     #
-    # Examples
+    # @visibility public
     #
+    # @param [Hash] options
+    # @option options [String] :transaction_id the transaction to verify.
+    # 
+    # @example
     #   mi = Mollie::Ideal.new('12345')
-    #   mi.check(:transaction_id => '12345')
+    #   mi.verify_transaction(:transaction_id => '482d599bbcc7795727650330ad65fe9b')
     #   # => {
-    #           :transaction_id => '482d599bbcc7795727650330ad65fe9b',
-    #           :amount => 1465,
-    #           :currency => 'EUR',
-    #           :payed => true,
-    #           :consumer => {
-    #             :name => 'Hr J Janssen',
-    #             :account => 'P001234567',
-    #             :city => 'Amsterdam'
-    #           },
-    #           :message => 'This iDEAL-order has successfuly been payed for, 
-    #                        and this is the first time you check it.'
-    #         }
+    #   #        :transaction_id => '482d599bbcc7795727650330ad65fe9b',
+    #   #        :amount => 1465,
+    #   #        :currency => 'EUR',
+    #   #        :payed => true,
+    #   #        :consumer => {
+    #   #          :name => 'Hr J Janssen',
+    #   #          :account => 'P001234567',
+    #   #          :city => 'Amsterdam'
+    #   #        },
+    #   #        :message => 'This iDEAL-order has successfuly been payed for, 
+    #   #                     and this is the first time you check it.'
+    #   #      }
     # TODO: docs mention 'status' instead of 'message'
-    #
-    # Returns A Hash representing the result of the transaction (see Examples).
-    def check(options);end
-
+    # 
+    # @note Once a transaction is payed, only the next time you verify the
+    #   transaction will the value of 'payed' be 'true'. 
+    #   Else it will be 'false'.
+    # @return [Hash] the status of the transaction (see example)
+    def verify_transaction(options);end
   end
 end

data/mollie-ideal.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "tomdoc"
-  # s.add_development_dependency "nokogiri"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rdiscount"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mollie-payment
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000Z
+date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: tomdoc
-  requirement: &70290978503740 !ruby/object:Gem::Requirement
+  name: yard
+  requirement: &70303083420680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70290978503740
+  version_requirements: *70303083420680
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70303083420260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303083420260
 description: WIP
 email:
 - gert@thinkcreate.nl
@@ -62,3 +73,4 @@ signing_key:
 specification_version: 3
 summary: WIP
 test_files: []
+has_rdoc: