Permalink
Browse files

final changes

  • Loading branch information...
1 parent d4f02e3 commit ac876a5e070be2e7a45582c09439eb24d842cc3d Manuel van Rijn committed Feb 16, 2012
Showing with 60 additions and 58 deletions.
  1. +4 −0 CHANGELOG.md
  2. +20 −0 LICENSE.md
  3. +23 −50 README.md
  4. +7 −2 bin/mollie-bank
  5. +3 −3 lib/mollie-bank/application/views/info.haml
  6. +3 −3 mollie-bank.gemspec
View
@@ -0,0 +1,4 @@
+# Changelog
+
+- **16 February 2012**: version 0.0.1
+ - Initial release
View
@@ -0,0 +1,20 @@
+Copyright (c) 2012 Manuel van Rijn, http://manuel.manuelles.nl/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,79 +1,52 @@
# Mollie-Bank
-A simple implementation of the "TM Bank" by Mollie, but without the portforward stuff to test your iDeal transactions localy.
+A simple implementation of the "TM Bank" by [Mollie](http://www.mollie.nl), but without the portforward stuff to test your iDeal transactions localy.
-## Install and Run it
+## Getting started
-Install the gem
+### Install
+
+To install the gem you should execute
```
gem install mollie-bank
```
-Run the mollie-bank
+Or if you are implementing this into a Rails project you could add the gem into your `Gemfile`.
```
-mollie-bank
+gem 'mollie-bank'
```
-Check if it works by browsing to: [http://localhost:4567/](http://localhost:4567/)
-
-## Howto implement
-
-Here's a list with examples how to use this gem in combination with some API/Frameworks I found/used. Feel free to extend this list with your examples.
-
-### Ruby on Rails
-
-Add the `mollie-bank` to your Gemfile
+Finally, if you don’t dig any of that gemming that’s so popular nowadays, you can install it as a plugin for you Rails project:
```
-gem 'mollie-bank', :git => 'https://github.com/manuelvanrijn/mollie-bank.git'
+cd vendor/plugins
+git clone --depth 1 git://github.com/manuelvanrijn/mollie-bank.git mollie-bank
```
-Change you config.ru so it will run the mollie-bank when you start the rails server. For example, I changed the following:
+### Running the Mollie Bank
-```
-# This file is used by Rack-based servers to start the application.
+After installation you can simple run:
-require ::File.expand_path('../config/environment', __FILE__)
-run YourRailsApplicationName::Application
```
-
-into:
-
+mollie-bank
```
-# This file is used by Rack-based servers to start the application.
-require ::File.expand_path('../config/environment', __FILE__)
-require 'mollie-bank'
+Check if it works by browsing to: [http://localhost:4567/](http://localhost:4567/)
-# - Make sinatra play nice
-use Rack::MethodOverride
-disable :run, :reload
+## Howto implement
-map "/" do
- run YourRailsApplicationName::Application
-end
+By default all communication for iDeal transactions is through [https://secure.mollie.nl/xml/ideal](https://secure.mollie.nl/xml/ideal). To use the "Mollie Bank" gem, you have to change this path into http://localhost:4567/xml/ideal](http://localhost:4567/xml/ideal).
-configure(:development) {
- map "/mollie-bank" do
- run MollieBank::Application
- end
-}
-```
+Of course you only want to use this in development mode, so you have to create some code to change this path only when it isn't in production mode.
-At this point you must communicate with [http://localhost:3000/mollie-bank/xml/ideal](http://localhost:3000/mollie-bank/xml/ideal) instead of the official [https://secure.mollie.nl/xml/ideal](https://secure.mollie.nl/xml/ideal)
+Check the [Wiki: Implement into existing modules](https://github.com/manuelvanrijn/mollie-bank/wiki/Implement-into-existing-modules) page for implementation of existing frameworks/modules.
-#### Use the ideal-mollie gem
+## Changelog
-If you are using the [ideal-mollie](https://github.com/manuelvanrijn/ideal-mollie) gem, you can easely implement this by changing / adding two lines to you `config.ru`
+A detailed overview of can be found in the [CHANGELOG](https://github.com/manuelvanrijn/mollie-bank/blob/master/CHANGELOG.md).
-```
-configure(:development) {
- map "/mollie-bank" do
- IdealMollie.send(:remove_const, 'MOLLIE_URL')
- IdealMollie.const_set('MOLLIE_URL', 'http://localhost:3000/mollie-bank/xml/ideal')
- run MollieBank::Application
- end
-}
-```
+## Copyright
+
+Copyright © 2012 Manuel van Rijn. See [LICENSE](https://github.com/manuelvanrijn/mollie-bank/blob/master/LICENSE.md) for further details.
View
@@ -1,5 +1,4 @@
#!/usr/bin/env ruby
-#
begin
require 'mollie-bank'
rescue LoadError => e
@@ -9,5 +8,11 @@ rescue LoadError => e
require 'mollie-bank'
end
+puts "== Mollie Bank started!"
+puts " please visit: http://localhost:4567/"
+puts ""
+
MollieBank::Application.run!
-puts "Mollie Bank started"
+
+puts ""
+puts "== Mollie Bank stopped. Good bye"
@@ -5,12 +5,12 @@
.row
.span4
%h1 Step 1
- %p Make sure you change the url <a>https://secure.mollie.nl/xml/ideal</a> into <a>http://localhost:3000/mollie-bank/xml/ideal</a>
- %p If you are using the <a href="https://github.com/manuelvanrijn/ideal-mollie">ideal-mollie</a> gem, you only have to include this gem into you gemfile.
+ %p Make sure you change the url <a>https://secure.mollie.nl/xml/ideal</a> into <a>http://localhost:4567/xml/ideal</a>
+ %p If you are using a existing framework/module, you might find additional implementation information on the <a href="https://github.com/manuelvanrijn/mollie-bank/wiki/Implement-into-existing-modules">Wiki: 'Implement into existing modules'</a>.
.span4
%h1 Step 2
%p Make sure the <code>returnurl</code> and the <code>reporturl</code> are set to your local address. So for example you would have:
<code>http://localhost:3000/transactions/report</code>
.span4
%h1 Step 3
- You'll now see Mollie Bank in the bank selection.
+ You'll now see <strong>"Mollie Bank"</strong> in the bank selection.
View
@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
s.version = MollieBank::VERSION
s.authors = ["Manuel van Rijn"]
s.email = ["manuel@manuelles.nl"]
- s.homepage = ""
- s.summary = %q{Write a gem summary}
- s.description = %q{Write a gem description}
+ s.homepage = "https://github.com/manuelvanrijn/mollie-bank"
+ s.summary = %q{Mollie Bank server to make Mollie iDeal payments on your local machine}
+ s.description = %q{A small sinatra server that supports all the actions Mollie iDeal API needs to make a payment. Now you can test your transactions on you local machine without having to make portforwards}
s.rubyforge_project = "mollie-bank"

0 comments on commit ac876a5

Please sign in to comment.