adyen-skinbuilder 0.2.6 → 0.3.0

data/.gitignore

@@ -1,4 +1,3 @@
-.DS_Store
-pkg/*
-*.gem
-.bundle
+pkg
+.rvmrc
+.adyenrc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## Far Future??
+  * multiple user, assets upload, hosted system
+
+## Todo
+  * beautify index page, add 'new', 'edit', 'download'
+  * add locale support
+  * add more functions to binary to get a proper CLI tool (or move to adyen-admin??)
+  * more helper e.g. cutom fields
+  * auto re-login when session timed out
+
+## v0.3.0
+  * read adyen-admin credentials from cfg file
+  * show local / remote skins, option to sync
+  * add skin upload -> 'adyen-admin'
+  * add skin export
+  * gemify
+  * add custom skin path
+  * add order_data
+  * allow partials
+  * 100% function compatiable with version 0.2.0 (check raketasks)

data/Gemfile.lock

@@ -1,33 +1,76 @@
 PATH
   remote: .
   specs:
-    adyen-skinbuilder (0.2.5)
-      rack (>= 1.3)
-      slop (>= 1.6.0)
+    adyen-skinbuilder (0.3.0.rc2)
+      adyen-admin
+      sinatra
+      sinatra-contrib
+      vegas
 
 GEM
   remote: http://rubygems.org/
   specs:
+    adyen-admin (0.0.7)
+      mechanize
+      rubyzip
+    backports (2.5.1)
     diff-lcs (1.1.3)
+    domain_name (0.5.3)
+      unf (~> 0.0.3)
+    eventmachine (0.12.10)
     ffi (1.0.11)
     guard (1.0.1)
       ffi (>= 0.5.0)
       thor (~> 0.14.6)
-    guard-rspec (0.6.0)
+    guard-rspec (0.7.0)
       guard (>= 0.10.0)
+    mechanize (2.3)
+      domain_name (~> 0.5, >= 0.5.1)
+      mime-types (~> 1.17, >= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (~> 0.0, >= 0.0.9)
+    mime-types (1.18)
+    net-http-digest_auth (1.2)
+    net-http-persistent (2.6)
+    nokogiri (1.5.2)
+    ntlm-http (0.1.1)
     rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
     rack-test (0.6.1)
       rack (>= 1.0)
+    rake (0.9.2.2)
     rspec (2.9.0)
       rspec-core (~> 2.9.0)
       rspec-expectations (~> 2.9.0)
       rspec-mocks (~> 2.9.0)
     rspec-core (2.9.0)
-    rspec-expectations (2.9.0)
+    rspec-expectations (2.9.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
-    slop (3.0.4)
+    rubyzip (0.9.7)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-contrib (1.3.1)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.3.0)
+      tilt (~> 1.3)
     thor (0.14.6)
+    tilt (1.3.3)
+    unf (0.0.5)
+      unf_ext
+    unf_ext (0.0.4)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    webrobots (0.0.13)
 
 PLATFORMS
   ruby
@@ -36,4 +79,5 @@ DEPENDENCIES
   adyen-skinbuilder!
   guard-rspec
   rack-test
-  rspec (>= 2.8)
+  rake
+  rspec

data/LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2011 
-Priit Haamer
+Copyright (c) 2012
+Priit Haamer, Tobias Bielohlawek
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,4 +18,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -1,33 +1,70 @@
-Simple Rack server to make Adyen skin authoring easier. Also includes rake tasks to bundle skin directories into deployable bundles.
+# Adyen Skinbuilder [![Build Status](https://secure.travis-ci.org/priithaamer/adyen-skinbuilder.png?branch=master)](http://travis-ci.org/priithaamer/adyen-skinbuilder)
+
+Simple Sinatra server to make Adyen skin authoring easier. It performs the template rendering on your local machine, which is very much similar to the end result generated in Adyen. Given adyen admin credentials provided, it allows to upload and test skins with just one click.
 
 ## Install
 
     sudo gem install adyen-skinbuilder
 
+
 ## Usage
 
-Make sure you have directory with basic Adyen skin structure, that looks something like this:
+Adyen Skinbuilder provides a Index page for full overview on all remote and local skins and options to up-/download etc. To load the page, start the server by providing the local path to your skin directory:
 
-    +- ~/Documents
-      +- DV3tf95f
-        +- css
-        +- img
-        +- inc
-          +- cfooter.txt
-          +- cheader.txt
-        +- js
+    $ adyen-skinbuilder ~/Documents
+
+Alternatively provide the full path to a skin which opens the browser and shows the rendered result directly.
+
+$ adyen-skinbuilder ~/Documents/DV3tf95f
+
+
+See `adyen-skinbuilder --help` for more options to run server on different port or with logging etc. Run `adyen-skinbuilder -k` to shutdown.
+
+
+## Skin Strucutre
+
+Usually Adyen requires to split up the skin page in up to four different files. But no worries, Skinbuilder does that for you. Yes, you read right: you just put all the html content in one file called `skin.html.erb` - Skinbuilder will auto split, zip and even upload the skin. Within the skin file you can make use of handy helper methods to define the adyen form and payment fields or even to render other partials.
+
+A most minimal file would look like:
+
+```html
+<h1> exmaple skin</h1>
+
+<% adyen_form_tag do %>
+  <h3>header</h3>
+  <%= adyen_payment_fields %>
+<% end %>
+
+```
 
-To view something that is very much similar to the end result generated in Adyen, fire up adyen-skinbuilder rack server, that does the template rendering on your local machine:
+### Code Sharing
 
-    $ adyen-skinbuilder ~/Documents/DV3tf95f
+Witha large number of skins it makes sense to reuse code + styling among several skins. This gem supports several ways how to share code in between:
 
-And go to http://localhost:8888 to see the generated page.
+#### Shared Partials
 
-See `adyen-skinbuilder --help` for more options to run server on different port or with logging etc.
+Similar as in rails, Skinbuilder allows to render other files inline, e.g.:
 
-### Base directory
 
-If you have multiple skin directories, this gem supports base directory that can provide files that will be included in all skins without the need to duplicate them. Let's consider this example:
+```html
+<h1>Exmaple Skin with partial</h1>
+
+<%= render_partial 'header.html' %>
+
+<% adyen_form_tag do %>
+  <h3>header</h3>
+  <%= adyen_payment_fields %>
+<% end %>
+
+```
+
+This will load and render `header.html.erb` for your skin root on top of the form.
+
+#### Base directory
+
+_Deprecated since Version 0.3_
+
+Another way is to create a `base` directory to provide fallback files that will be included in all skins without the need to duplicate them. Let's consider this example:
 
     +- ~/Documents
       +- base
@@ -40,21 +77,26 @@ If you have multiple skin directories, this gem supports base directory that can
 
 File in specific skin directory takes precedence when building skin zip file. In this example, `cheader.txt` will be bundled from skin directory `DV3tf95f/inc` but `cfooter.txt` comes from `base/inc`.
 
-## Order Data
+### Order Data
 
 Adyen let's you post order data that will be shown in shopping cart view as part of html. You can put `order_data.txt` file into `inc/` folder in the skin directory. This file will be included automatically in the same place, where adyen would put it.
 
-## Building skin for upload
+## Interacting with remote Adyen Admin
 
-There is a convenient Rake task that will create zip file of the skin file. It can be used either by providing directories as rake task arguments:
+To interact with the remote Adyen Admin interface, Skinbuilder makes use of the [adyen-admin](https://github.com/rngtng/adyen-admin) gem. This
+allows to download/upload skins easily. To enable remote admin, provide the Adyen Admin credentials within the `.adyenrc` file, either in you home- or execution root directory. !!We encourage to set up a dedicated useraccount with low rights for that!!
 
-    rake adyen:skin:build['/path/to/skin/directory','/path/to/target']
+An example `.adyenrc` file:
 
-Also, providing environment variables will work:
+    scope: test
+    accountname: <your account>
+    username: <your username>
+    password: <your password>
 
-    rake adyen:skin:build SKIN=/path/to/skin/directory TARGET=/path/to/target
 
-### More meaningful file naming
+Navigate to the index page `/` and hit `Sync once and you'll find the option to upload the skins. In anycase you always can download the zipped skinfile via the `compile` link. *By now, only adyen test is provided*
+
+## More meaningful file naming
 
 Adyen requires the name of root directory within the zip file to exactly match the skincode, e.g. `DV3tf95f`.
 These skincodes are not very meaningful and hard to remember.
@@ -66,6 +108,23 @@ So in this example, the zip file would be called `BrandX-shop-DV3tf95f.zip`, and
 
 If the skin directory does not match this pattern, the zip and root directory within the zip will both be named after the original skin directory name.
 
-## Contributors 
+## Contributors
 
 [See the list of contributiors](https://github.com/priithaamer/adyen-skinbuilder/network/members)
+
+
+## Contributing
+
+We'll check out your contribution if you:
+
+- Provide a comprehensive suite of tests for your fork.
+- Have a clear and documented rationale for your changes.
+- Package these up in a pull request.
+
+We'll do our best to help you out with any contribution issues you may have.
+
+
+## License
+
+The license is included as LICENSE in this directory.
+

data/Rakefile

@@ -1,2 +1,8 @@
 require 'bundler'
+require 'rspec/core/rake_task'
+
 Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/adyen-skinbuilder.gemspec

@@ -5,21 +5,22 @@ Gem::Specification.new do |s|
   s.name        = 'adyen-skinbuilder'
   s.version     = Adyen::Skinbuilder::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Priit Haamer']
-  s.email       = ['priit@edicy.com']
+  s.authors     = ['Priit Haamer', 'Tobias Bielohlawek']
+  s.email       = ['priit@edicy.com', 'tobi@soundcloud.com']
   s.homepage    = 'http://rubygems.org/gems/adyen-skinbuilder'
-  s.summary     = %q{Simple Rack server to make coding Adyen skins easier}
-  s.description = %q{Provides helpful rake tasks and command line tools to run rack server and bundle adyen skin files}
+  s.summary     = %q{Simple Sinatra server to make coding Adyen skins easier}
+  s.description = %q{Provides helpful command line tools to run sinatra server and bundle adyen skin files}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-  
-  s.add_dependency 'rack', '>= 1.3'
-  s.add_dependency 'slop', '>= 1.6.0'
-  
-  s.add_development_dependency 'rspec', '>= 2.8'
-  s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rack-test'
+
+  %w(sinatra sinatra-contrib vegas adyen-admin).each do |gem|
+    s.add_runtime_dependency *gem.split(' ')
+  end
+
+  %w(rake rspec guard-rspec rack-test).each do |gem|
+    s.add_development_dependency *gem.split(' ')
+  end
 end

data/bin/adyen-skinbuilder

@@ -1,6 +1,31 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'adyen-skinbuilder'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/adyen-skinbuilder/server")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/hash")
+require 'vegas'
 
-Adyen::SkinBuilder::Launcher.ignition
+opts = {}
+
+
+if (skins = ARGV.last) && File.directory?(skins)
+  opts[:skins_directory] = skins
+
+  begin
+    skin = Adyen::Admin::Skin.new(:path => skins) #auto launch skin
+    opts[:launch_path] = "/#{skin.code}"
+  rescue ArgumentError
+  end
+end
+
+adyen_rc_file = ".adyenrc"
+
+if !File.exists?(adyen_rc_file)
+  adyen_rc_file = File.expand_path("~/#{adyen_rc_file}")
+end
+
+begin
+  opts[:adyen_admin_cfg] = YAML::load(::File.open(adyen_rc_file)).symbolize_keys!
+rescue
+end
+
+Vegas::Runner.new(Adyen::SkinBuilder::Server, 'adyen-skinbuilder', opts)

data/lib/adyen-skinbuilder.rb

@@ -1,8 +1,5 @@
-require 'adyen-skinbuilder/server'
 require 'adyen-skinbuilder/version'
-require 'adyen-skinbuilder/launcher'
-
-require 'adyen-skinbuilder/railtie' if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3
+#require 'adyen-skinbuilder/server'
 
 # TODO: skin bundle generator
 # TODO: Init task to build adyen skins directory structure

data/lib/adyen-skinbuilder/helper/adyen.rb

@@ -0,0 +1,29 @@
+module Adyen
+  module SkinBuilder
+    module Helper
+      module Adyen
+
+        # start the adyen form, if no block padded payment fields are auto included
+        def adyen_form_tag(&block)
+          buffer << render_partial(:adyen_form, :views => settings.views, :block => block)
+        end
+
+        # render the payment fields
+        def adyen_payment_fields(&block)
+          if block_given?
+            capture &block
+          else
+            render_partial :adyen_payment_fields, :views => settings.views
+          end
+        end
+
+        # to be done
+        # def adyen_custom_field_tag
+        # end
+        #
+        # def adyen_custom_hidden_tag
+        # end
+      end
+    end
+  end
+end

data/lib/adyen-skinbuilder/helper/render.rb

@@ -0,0 +1,32 @@
+module Adyen
+  module SkinBuilder
+    module Helper
+      module Render
+
+        # the output buffer
+        def buffer
+          @_out_buf || @_buf
+        end
+
+        # capture rednered output to a string
+        def capture
+          pos = buffer.size
+          yield
+          buffer.slice!(pos..buffer.size)
+        end
+
+        # renders a file from the inc folder of the skin
+        def render_file(file)
+          file = skin_path @skin_code, "/inc/#{file}.txt"
+          File.read(file) if File.exists?(file)
+        end
+
+         # render an erb partial inline
+        def render_partial(file, locals = {})
+          views = locals.delete(:views) || skin_path(@skin_code)
+          erb "_#{file}.html".to_sym, :layout => false, :views => views, :locals => locals
+        end
+      end
+    end
+  end
+end

data/lib/adyen-skinbuilder/server.rb

@@ -1,77 +1,131 @@
-require 'rack'
+require 'rubygems'
+require 'bundler/setup'
+
+require 'sinatra/base'
+require 'adyen-skinbuilder/helper/adyen'
+require 'adyen-skinbuilder/helper/render'
+
+require 'adyen-admin'
 
 module Adyen
   module SkinBuilder
-    class SkeletonAdapter
-      
-      def initialize(skins_directory)
-        @skins_directory = File.dirname(skins_directory)
-        @order_data_file = 
-        @skin = File.basename(skins_directory)
+    class Server < Sinatra::Base
+      dir = File.dirname(File.expand_path(__FILE__))
+
+      set :views, "#{dir}/server/views"
+
+      # method will be overwritten by _vegas_ if skin directory given
+      def self.skins_directory
+        File.expand_path(".")
       end
-      
-      def call(env)
-        body = File.read(File.join(File.dirname(__FILE__), '../../adyen/skeleton.html'))
-        body = body.gsub(/\$skinCode/, @skin)
-        %w(cheader pmheader pmfooter customfields cfooter).each do |inc|
-          body = body.gsub(%r{\<!-- ### inc\/#{inc}_\[locale\].txt or inc\/#{inc}.txt \(fallback\) ### --\>}, get_inc(inc))
+
+      def self.adyen_admin_cfg
+        nil
+      end
+
+      def skins_directory
+        @@skins_directory ||= begin
+          Adyen::Admin::Skin.new(:path => settings.skins_directory)
+          File.dirname(settings.skins_directory)
+        rescue ArgumentError
+          settings.skins_directory
         end
-        body = body.gsub(%r{\<!-- Adyen Main Content --\>}, main_content)
-        
-        [200, {'Content-Type' => 'text/html'}, [body]]
       end
-      
-      private
-      
-      def main_content
-        File.read(File.join(File.dirname(__FILE__), '../../adyen/main_content.html')).gsub(%r{\<!-- Adyen Order Data --\>}, get_inc('order_data'))
+
+      def skin_path(*path)
+        File.join(skins_directory, *path)
       end
-      
-      # TODO: add locale support so files like inc/cheader_[locale].txt will be included correctly
-      def get_inc(filename)
-        if File.exists?(File.join(@skins_directory, @skin, 'inc', "#{filename}.txt"))
-          File.read(File.join(@skins_directory, @skin, 'inc', "#{filename}.txt"))
-        elsif File.exists?(File.join(@skins_directory, 'base', 'inc', "#{filename}.txt"))
-          File.read(File.join(@skins_directory, 'base', 'inc', "#{filename}.txt"))
-        else
-          "<!-- == #{filename}.txt IS MISSING == -->"
+
+      def skin_file(skin_code)
+        skin_path(skin_code, "skin.html").tap do |file|
+          if !File.exists?("#{file}.erb")
+            file.replace File.join(settings.views, "skin.html")
+          end
         end
       end
-    end
-   
-    class Redirector 
-      def call(env)    
-        [302, {"Location" => "https://test.adyen.com#{env["REQUEST_PATH"]}"}, self]
+
+      def store(output)
+        output.scan(/<!-- ### inc\/([a-z]+) -->(.+?)<!-- ### -->/m) do |name, content|
+          file = skin_path @skin_code, "/inc/#{name}.txt"
+          `mkdir -p #{File.dirname(file)}`
+          File.open(file, "w") do |f|
+            f.write content.strip
+          end
+        end
       end
-      def each(&block); end
-    end
- 
-    class Server
-      
-      class << self
 
-        def run(config)
-          Rack::Server.start(:app => self.app(config), :Port => config[:port], :AccessLog => [])
+      def adyen_login
+        if settings.adyen_admin_cfg && !Adyen::Admin.authenticated?
+          cfg = settings.adyen_admin_cfg
+          Adyen::Admin.login(cfg[:accountname], cfg[:username], cfg[:password])
         end
-      
-        def app(config = {})
-          Rack::Builder.app do
-            use Rack::CommonLogger if config[:log]
-            use Rack::Head
-            
-            map("/sf/#{File.basename(config[:skins_directory])}") do
-              run Rack::Cascade.new([
-                Rack::File.new(config[:skins_directory]),
-                Rack::File.new(File.join(File.dirname(config[:skins_directory]), 'base'))
-              ])
+      end
+
+      helpers Helper::Render, Helper::Adyen
+
+      get '/sf/:skin_code/*' do |skin_code, path|
+        if (file = skin_path(skin_code, path)) && File.exists?(file)
+          send_file file
+        elsif (file = skin_path("base", path)) && File.exists?(file)
+          send_file file
+        end
+      end
+
+      get '/hpp/*' do |path|
+        send_file File.join(settings.views, path).tap { |file|
+          if !File.exists?(file)
+            `mkdir -p #{File.dirname(file)}`
+            `wget https://test.adyen.com/hpp/#{path} -O #{file}`
+          end
+        }
+      end
+
+      get '/favicon.ico' do
+      end
+
+      # skin page
+      get '/:skin_code' do |skin_code|
+        @skin_code = skin_code
+
+        erb(skin_file(@skin_code).to_sym, {
+          :views => '/',
+          :layout => File.join(settings.views, "layout.html").to_sym
+        }).tap do |output|
+          if @skin = Adyen::Admin::Skin.new(:path => skin_path(skin_code))
+            if params[:compile]
+              store(output)
+              send_file(@skin.compile) && return
+            elsif params[:upload]
+              store(output)
+              adyen_login
+              @skin.upload
             end
+          end
+        end
+      end
+
+      # cache remote skins
+      @@skin_cache = nil
 
-            # Redirect requests for default assets to Adyen: 
-            map("/hpp") { run Adyen::SkinBuilder::Redirector.new }
-        
-            map('/') { run Adyen::SkinBuilder::SkeletonAdapter.new(config[:skins_directory]) }
+      # index page
+      get '/' do
+        Adyen::Admin::Skin.default_path = skin_path
+        if params[:sync]
+          Adyen::Admin::Skin.purge_cache
+          adyen_login
+          @@skin_cache = Adyen::Admin::Skin.all
+        end
+        if params[:download] && (@skin = Adyen::Admin::Skin.find(params[:download]))
+          @skin.download.tap do |zip_file|
+            @skin.decompile(zip_file)
+            `cp #{skin_file(@skin.code)}.erb #{@skin.path}`
+            `rm -f #{zip_file}`
           end
         end
+        @skins = @@skin_cache || Adyen::Admin::Skin.all_local
+        @adyen_admin_cfg = settings.adyen_admin_cfg
+
+        erb 'index.html'.to_sym, :layout => false
       end
     end
   end