active_forms 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michał Szajbe
+
+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.

data/README.rdoc

@@ -0,0 +1,7 @@
+= active_forms
+
+ActiveForms API wrapper.
+
+== Copyright
+
+Copyright (c) 2010 Monterail. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "active_forms"
+    gem.summary = %Q{Active Forms API wrapper}
+    gem.email = "michal.szajbe@gmail.com"
+    gem.authors = ["Michał Szajbe"]
+    gem.homepage = "http://github.com/monterail/active_forms"
+    gem.add_dependency "activesupport", ">= 0"
+    gem.add_dependency "httparty", ">= 0.5.2"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 2.10.2"
+    gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_forms #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/active_forms.gemspec

@@ -0,0 +1,86 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_forms}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Micha\305\202 Szajbe"]
+  s.date = %q{2010-04-01}
+  s.email = %q{michal.szajbe@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "active_forms.gemspec",
+     "lib/active_forms.rb",
+     "lib/active_forms/application.rb",
+     "lib/active_forms/application_print.rb",
+     "lib/active_forms/configuration.rb",
+     "lib/active_forms/form.rb",
+     "lib/active_forms/mapper.rb",
+     "lib/active_forms/request.rb",
+     "test/active_forms/application_print_test.rb",
+     "test/active_forms/application_test.rb",
+     "test/active_forms/form_test.rb",
+     "test/active_forms/mapper_test.rb",
+     "test/active_forms/request_test.rb",
+     "test/active_forms_test.rb",
+     "test/fixtures/error.xml",
+     "test/fixtures/get_applicationdata.xml",
+     "test/fixtures/get_applicationprint.xml",
+     "test/fixtures/get_applications.xml",
+     "test/fixtures/get_applications_single.xml",
+     "test/fixtures/get_forms.xml",
+     "test/fixtures/get_forms_single.xml",
+     "test/fixtures/success.xml",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/monterail/active_forms}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Active Forms API wrapper}
+  s.test_files = [
+    "test/active_forms/application_print_test.rb",
+     "test/active_forms/application_test.rb",
+     "test/active_forms/form_test.rb",
+     "test/active_forms/mapper_test.rb",
+     "test/active_forms/request_test.rb",
+     "test/active_forms_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 2.10.2"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10.2"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10.2"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+  end
+end
+

data/lib/active_forms.rb

@@ -0,0 +1,36 @@
+require 'active_support'
+
+require 'active_forms/configuration'
+require 'active_forms/mapper'
+require 'active_forms/request'
+
+require 'active_forms/application'
+require 'active_forms/application_print'
+require 'active_forms/form'
+
+module ActiveForms
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+
+  class Error                   < StandardError; end
+
+  class MissingParameter        < Error; end
+  class ApiVersionNotSupported  < Error; end
+  class MissingVendor           < Error; end
+  class MissingResource         < Error; end
+  class ResourceNotSupported    < Error; end
+  class BadParameterFormat      < Error; end
+  class ApiKeyInvalid           < Error; end
+  class ApiTimestampInvalid     < Error; end
+  class ApiSigInvalid           < Error; end
+  class MethodNotAllowed        < Error; end
+  class FormNotFound            < Error; end
+  class FormVersionNotFound     < Error; end
+  class ApplicationNotFound     < Error; end
+end

data/lib/active_forms/application.rb

@@ -0,0 +1,27 @@
+class ActiveForms::Application < ActiveForms::Mapper
+  columns :number, :formCode, :formVersion, :date, :status, :isPrintable, :fieldData
+
+  class << self
+    # required params:
+    #   apiStatus = sent | saved | sent_to_be
+    def all(params = {})
+      response = ActiveForms::Request.get("applications", params)
+
+      hashes = response["applications"]["application"]
+      hashes = [hashes] if hashes.is_a?(Hash)
+
+      objects = hashes.map { |attributes| new(attributes) }
+    end
+
+    # required params:
+    #   apiFormCode - Form's code
+    #   apiNumber   - Application's number
+    def find(params = {})
+      response = ActiveForms::Request.get("applicationdata", params)
+
+      attributes = response["applicationData"]
+
+      new(attributes)
+    end
+  end
+end

data/lib/active_forms/application_print.rb

@@ -0,0 +1,20 @@
+class ActiveForms::ApplicationPrint < ActiveForms::Mapper
+  columns :formCode, :formVersionCode, :number, :date, :status, :contentType, :printContent
+
+  class << self
+    # required params:
+    #   apiFormCode - Form's code
+    #   apiNumber   - Application's number
+    def find(params = {})
+      response = ActiveForms::Request.get("applicationprint", params)
+
+      attributes = response["applicationPrint"]
+
+      new(attributes)
+    end
+  end
+
+  def printContent=(value)
+    @attributes["printContent"] = value.is_a?(String) ? value.strip : super
+  end
+end

data/lib/active_forms/configuration.rb

@@ -0,0 +1,10 @@
+module ActiveForms
+  class Configuration
+    attr_accessor :api_url, :url, :base_url, :api_key, :secret_key
+
+    def initialize
+      @api_url = { :protocol => "https", :host => 'api.activeforms.com' }
+      @url     = { :protocol => "https", :host => 'www.activeforms.com' }
+    end
+  end
+end

data/lib/active_forms/form.rb

@@ -0,0 +1,31 @@
+class ActiveForms::Form < ActiveForms::Mapper
+  columns :name, :code, :url, :status, :activeReleaseCode, :activeReleaseName, :title, :isPrintable
+
+  class << self
+    def all(params = {})
+      response = ActiveForms::Request.get("forms", params)
+
+      hashes = response["forms"]["form"]
+      hashes = [hashes] if hashes.is_a?(Hash)
+
+      objects = hashes.map { |attributes| new(attributes) }
+    end
+  end
+
+  def full_url
+    if url.starts_with?("http")
+      url
+    else
+      host = ActiveForms.configuration.url[:protocol] + "://" + ActiveForms.configuration.url[:host]
+      host << "/" << ActiveForms.configuration.base_url << "/" << url
+    end
+  end
+
+  def active?
+    status == "active"
+  end
+
+  def inactive?
+    status == "inactive"
+  end
+end

data/lib/active_forms/mapper.rb

@@ -0,0 +1,57 @@
+module ActiveForms
+  class Mapper
+
+    class << self
+      attr_reader :column_names
+
+      protected
+
+      def columns(*columns)
+        @column_names ||= []
+        @column_names += columns.map(&:to_s)
+
+        columns.each do |column|
+          define_method("#{column}") do
+            @attributes["#{column}"]
+          end
+
+          define_method("#{column}=") do |value|
+            @attributes["#{column}"] = value
+          end
+        end
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(attributes = {})
+      self.attributes = attributes
+    end
+
+    def attributes=(new_attributes = {})
+      @attributes = HashWithIndifferentAccess.new
+
+      # use attribute writers
+      new_attributes.each { |k, v| respond_to?("#{k}=") ? send("#{k}=", v) : (@attributes[k] = v) }
+
+      @attributes.stringify_keys!
+    end
+
+    # ignore
+    def xmlns=(value)
+      nil
+    end
+
+    # ignore
+    def apiVersion=(value)
+      nil
+    end
+
+    def ==(comparison_object)
+      attributes == comparison_object.attributes
+    end
+
+    alias_method :equal?, :==
+    alias_method :eql?, :==
+  end
+end

data/lib/active_forms/request.rb

@@ -0,0 +1,86 @@
+require 'digest/sha1'
+require 'cgi'
+require 'httparty'
+
+module ActiveForms
+  class Request
+    attr_reader :http_method, :path, :params, :api_params, :uri
+
+    class << self
+      def get(path, all_params = {})
+        new(:get, path, all_params).perform
+      end
+
+      def post(path, all_params = {})
+        new(:post, path, all_params).perform
+      end
+
+      def delete(path, all_params = {})
+        new(:delete, path, all_params).perform
+      end
+    end
+
+    def initialize(http_method, path, all_params = {})
+      all_params.stringify_keys!
+
+      @http_method = http_method.to_s.upcase
+      @path        = path.to_s
+      @api_params  = {}
+      @params      = {}
+
+      all_params.each do |k, v|
+        if k.starts_with?("api")
+          @api_params[k] = v
+        else
+          @params[k] = v
+        end
+      end
+
+      @api_params["apiKey"]       = ActiveForms.configuration.api_key
+      @api_params["apiVersion"]   = "1.0"
+      @api_params["apiTimestamp"] ||= Time.now.utc.iso8601(3)
+      @api_params["apiSig"]       = api_sig
+
+      @uri = build_uri
+    end
+
+    def perform
+      response = HTTParty.send(http_method.downcase, uri)
+      raise_error(response)
+      response
+    end
+
+    private
+
+    def build_uri
+      params     = http_method == "GET" ? @params.map { |k, v| "#{k}=#{CGI::escape(v)}" } : []
+      api_params = @api_params.map { |k, v| "#{k}=#{v}" }
+
+      url_with_path + "?" + [params, api_params].flatten.join("&")
+    end
+
+    def url_with_path
+      url = ActiveForms.configuration.api_url[:protocol] + "://" + ActiveForms.configuration.api_url[:host]
+      [url, ActiveForms.configuration.base_url, path].join('/')
+    end
+
+    def api_sig
+      string = [
+        http_method,
+        url_with_path,
+        api_params["apiKey"],
+        api_params["apiTimestamp"],
+        ActiveForms.configuration.secret_key
+      ].join.downcase
+
+      Digest::SHA1.hexdigest(string)
+    end
+
+    def raise_error(response)
+      if response["error"]
+        klass = ("ActiveForms::" << response["error"]["code"].downcase.camelize).constantize
+        raise klass.new(response["error"]["message"])
+      end
+    end
+  end
+end

data/test/active_forms/application_print_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class ActiveForms::ApplicationPrintTest < Test::Unit::TestCase
+  context "" do
+    setup do
+      configure
+    end
+
+    context "instance" do
+      setup do
+        @application         = ActiveForms::ApplicationPrint.new(
+          :number            => "1234",
+          :form_code         => "credit_card_application",
+          :form_version_code => "version_1",
+          :date              => "2007-08-23T12:43:03",
+          :status            => "sent",
+          :content_type      => "application/pdf",
+          :print_content     => "wAARCAMABAADASIA"
+        )
+      end
+
+      should "have correctly built attributes" do
+        attributes            = {
+          "number"            => "1234",
+          "form_code"         => "credit_card_application",
+          "form_version_code" => "version_1",
+          "date"              => "2007-08-23T12:43:03",
+          "status"            => "sent",
+          "content_type"      => "application/pdf",
+          "print_content"     => "wAARCAMABAADASIA"
+        }
+
+        assert_equal attributes, @application.attributes
+      end
+    end
+
+    context "when sent ActiveForms::ApplicationPrint.find with form code and application number" do
+      setup do
+        stub_get(/applicationprint/, success_response("get_applicationprint"))
+        @application_print = ActiveForms::ApplicationPrint.find(:apiFormCode => "credit_card_application", :apiNumber => "23456")
+      end
+
+      should "respond with ApplicationPrint instance" do
+        application_print  = ActiveForms::ApplicationPrint.new(
+          :number          => "23456",
+          :formCode        => "credit_card_application",
+          :formVersionCode => "version_1",
+          :date            => "2007-08-23T12:43:03",
+          :status          => "sent",
+          :contentType     => "application/pdf",
+          :printContent    => "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAMABAADASIA"
+        )
+
+        assert_equal application_print, @application_print
+      end
+    end
+  end
+end

data/test/active_forms/application_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+class ActiveForms::ApplicationTest < Test::Unit::TestCase
+  context "" do
+    setup do
+      configure
+    end
+
+    context "instance" do
+      setup do
+        @application = ActiveForms::Application.new(
+          :number     => "1234",
+          :form_code  => "credit_card_application",
+          :field_data => {
+            :last_name     => "Kowalski",
+            :ubezpieczenie => ["ubezpieczenie_karty", "na_zycie"]
+          }
+        )
+      end
+
+      should "have correctly built attributes" do
+        attributes = {
+          "number"     => "1234",
+          "form_code"  => "credit_card_application",
+          "field_data" => {
+            "last_name"     => "Kowalski",
+            "ubezpieczenie" => ["ubezpieczenie_karty", "na_zycie"]
+          }
+        }
+
+        assert_equal attributes, @application.attributes
+      end
+    end
+
+    context "when sent ActiveForms::Application.all with multi-response" do
+      setup do
+        stub_get(/applications/, success_response("get_applications"))
+        @applications = ActiveForms::Application.all
+      end
+
+      should "respond with array of Application instances" do
+        application1 = ActiveForms::Application.new(
+          :number          => "12234",
+          :formCode        => "credit_card_application",
+          :formVersionCode => "version_1",
+          :date            => "2007-08-23T12:43:03",
+          :status          => "sent",
+          :isPrintable     => "true"
+        )
+
+        application2 = ActiveForms::Application.new(
+          :number          => "12235",
+          :formCode        => "credit_card_application",
+          :formVersionCode => "version_1",
+          :date            => "2007-08-23T12:44:03",
+          :status          => "sent",
+          :isPrintable     => "true"
+        )
+
+        assert @applications.include?(application1)
+        assert @applications.include?(application2)
+        assert_equal 2, @applications.size
+      end
+    end
+
+    context "when sent ActiveForms::Application.all with single-response" do
+      setup do
+        stub_get(/applications/, success_response("get_applications_single"))
+        @applications = ActiveForms::Application.all
+      end
+
+      should "respond with array of Application instances" do
+        application = ActiveForms::Application.new(
+          :number          => "12234",
+          :formCode        => "credit_card_application",
+          :formVersionCode => "version_1",
+          :date            => "2007-08-23T12:43:03",
+          :status          => "sent",
+          :isPrintable     => "true"
+        )
+
+        assert_equal [application], @applications
+      end
+    end
+  end
+end

data/test/active_forms/form_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class ActiveForms::FormTest < Test::Unit::TestCase
+  context "" do
+    setup do
+      configure
+    end
+
+    context "when sent ActiveForms::Form.all with multi-response" do
+      setup do
+        stub_get(/forms/, success_response("get_forms"))
+        @forms = ActiveForms::Form.all
+      end
+
+      should "respond with array of Form instances" do
+        @form1 = ActiveForms::Form.new(
+          :name              => "Wniosek o~karte kredytowa",
+          :code              => "credit_card_application",
+          :url               => "https://www.activeforms.com/mybank/wniosek_o_karte_kredytowa",
+          :status            => "active",
+          :activeReleaseCode => "version_1",
+          :activeReleaseName => "Wersja pierwsza",
+          :title             => "Wniosek o~karte kredytowa",
+          :isPrintAgreement  => "isPrintable"
+        )
+
+        @form2 = ActiveForms::Form.new(
+          :name   => "Wniosek o~kredyt hipoteczny",
+          :code   => "mortgage_credit",
+          :url    => "https://www.activeforms.com/mybank/wniosek_o_kredyt_hipoteczny",
+          :status => "inactive"
+        )
+
+        assert @forms.include?(@form1)
+        assert @forms.include?(@form2)
+        assert_equal 2, @forms.size
+      end
+    end
+
+    context "when sent ActiveForms::Form.all with single-response" do
+      setup do
+        stub_get(/forms/, success_response("get_forms_single"))
+        @forms = ActiveForms::Form.all
+      end
+
+      should "respond with array of Form instances" do
+        @form = ActiveForms::Form.new(
+          :name   => "Wniosek o~kredyt hipoteczny",
+          :code   => "mortgage_credit",
+          :url    => "https://www.activeforms.com/mybank/wniosek_o_kredyt_hipoteczny",
+          :status => "inactive"
+        )
+
+        assert_equal [@form], @forms
+      end
+    end
+
+    context "given a form with full url" do
+      setup { @form = ActiveForms::Form.new(:url => "https://www.example2.com/client/pit") }
+
+      should "return url as full_url" do
+        assert_equal "https://www.example2.com/client/pit", @form.full_url
+      end
+    end
+
+    context "given a form with no full url" do
+      setup { @form = ActiveForms::Form.new(:url => "pit") }
+
+      should "construct full_url" do
+        assert_equal "https://www.example.com/client/pit", @form.full_url
+      end
+    end
+
+    context "given a form with active status" do
+      setup { @form = ActiveForms::Form.new(:status => "active") }
+
+      should "respond with true when sent #active?" do
+        assert @form.active?
+      end
+      should "respond with false when sent #inactive?" do
+        assert !@form.inactive?
+      end
+    end
+
+    context "given a form with inactive status" do
+      setup { @form = ActiveForms::Form.new(:status => "inactive") }
+
+      should "respond with true when sent #inactive?" do
+        assert @form.inactive?
+      end
+      should "respond with false when sent #active?" do
+        assert !@form.active?
+      end
+    end
+  end
+end

data/test/active_forms/mapper_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class ActiveForms::MapperTest < Test::Unit::TestCase
+  context "mapper class" do
+    setup do
+      configure
+    end
+
+    teardown do
+      reset_mapper("Dummy")
+    end
+
+    context "when sent #columns" do
+      setup do
+        Dummy.send(:columns, :one, :two)
+        @dummy = Dummy.new
+      end
+
+      should "define column accessors that read/write attributes" do
+        assert @dummy.respond_to?(:one)
+        assert @dummy.respond_to?(:two)
+
+        @dummy.one = "fake"
+
+        assert_equal "fake", @dummy.attributes["one"]
+        assert_equal "fake", @dummy.one
+
+        assert_same_elements ["one", "two", "name", "formCode"], Dummy.column_names
+      end
+    end
+
+    context "instance" do
+      setup do
+        @dummy = Dummy.new(:name => "fake", :formCode => "code")
+      end
+
+      should "have attributes set" do
+        assert_equal "fake", @dummy.name
+        assert_equal "code", @dummy.formCode
+      end
+
+      should "use writer methotd when mass assigning attributes" do
+        @dummy.instance_eval do
+          def name=(value)
+            @attributes["name"] = "#{value} modified"
+          end
+        end
+
+        @dummy.attributes = { :name => "name" }
+
+        assert_equal "name modified", @dummy.name
+      end
+    end
+  end
+end

data/test/active_forms/request_test.rb

@@ -0,0 +1,113 @@
+require 'test_helper'
+
+class ActiveForms::RequestTest < Test::Unit::TestCase
+  context "" do
+    setup { configure }
+
+    context "GET request" do
+      setup do
+        @request = ActiveForms::Request.new(:get, "forms", :param => "a&b value", :apiTimestamp => Time.parse("2010-02-18T01:18:19.218Z").utc.iso8601(3), :apiParam => "apiValue", :apiKey => "fake", :apiVersion => "fake", :apiSig => "fake")
+      end
+
+      should "recognize params and apiParams" do
+        assert_equal "a&b value", @request.params["param"]
+        assert_equal "2010-02-18T01:18:19.218Z", @request.api_params["apiTimestamp"]
+      end
+
+      should "set apiKey, apiVersion and apiSig params by itself" do
+        assert_not_equal "fake", @request.api_params["apiKey"]
+        assert_not_equal "fake", @request.api_params["apiVersion"]
+        assert_not_equal "fake", @request.api_params["apiSig"]
+      end
+
+      should "have apiSig counted" do
+        assert_equal "8069430fe9aabbc2c2fcc895cd423f2a83085185", @request.api_params["apiSig"]
+      end
+
+      should "have correct uri" do
+        assert_same_uri "https://api.example.com/client/forms?apiSig=8069430fe9aabbc2c2fcc895cd423f2a83085185&apiKey=123456&apiTimestamp=2010-02-18T01:18:19.218Z&apiVersion=1.0&param=a%26b+value&apiParam=apiValue", @request.uri
+      end
+
+      should "have params escaped in uri" do
+        assert @request.uri.include?("a%26b+value")
+        assert !@request.uri.include?("a&b value")
+      end
+
+      context "when performed with success" do
+        setup do
+          stub_get(@request.uri, success_response)
+          @response = @request.perform
+        end
+
+        should "return response as no-error hash" do
+          assert @response.is_a?(Hash)
+          assert !@response.has_key?("error")
+        end
+      end
+
+      context "when performed with failure" do
+        setup do
+          stub_get(@request.uri, error_response)
+        end
+
+        should "raise error" do
+          assert_raise ActiveForms::ApiTimestampInvalid, "Api timestamp parameter value out of 15 minutes slot" do
+            @request.perform
+          end
+        end
+      end
+    end
+
+    context "POST request" do
+      setup do
+        @request = ActiveForms::Request.new(:post, "forms", :param => "a&b value", :apiTimestamp => Time.parse("2010-02-18T01:18:19.218Z").utc.iso8601(3), :apiParam => "apiValue")
+      end
+
+      should "have api_sig counted" do
+        assert_equal "fa9c81c5fcdf078528730ff765044f7d4dbcaa8e", @request.api_params["apiSig"]
+      end
+
+      should "have correct uri" do
+        assert_same_uri "https://api.example.com/client/forms?apiSig=fa9c81c5fcdf078528730ff765044f7d4dbcaa8e&apiKey=123456&apiTimestamp=2010-02-18T01:18:19.218Z&apiVersion=1.0&apiParam=apiValue", @request.uri
+      end
+    end
+
+    context "Request.post(path)" do
+      setup do
+        stub_post(/.+/, success_response)
+        @response = ActiveForms::Request.post("forms", :param => "value")
+      end
+
+      should "be equivalent to Request.new(:post, path).perform" do
+        request = ActiveForms::Request.new(:post, "forms", :param => "value")
+        assert_equal @response, request.perform
+      end
+    end
+
+    context "DELETE request" do
+      setup do
+        @request = ActiveForms::Request.new(:delete, "forms", :param => "a&b value", :apiTimestamp => Time.parse("2010-02-18T01:18:19.218Z").utc.iso8601(3), :apiParam => "apiValue")
+      end
+
+      should "have api_sig counted" do
+        assert_equal "ac5efc63ff1382765fdc29940cf6fb7119f9c763", @request.api_params["apiSig"]
+      end
+
+      should "have correct uri" do
+        assert_same_uri "https://api.example.com/client/forms?apiSig=ac5efc63ff1382765fdc29940cf6fb7119f9c763&apiKey=123456&apiTimestamp=2010-02-18T01:18:19.218Z&apiVersion=1.0&apiParam=apiValue", @request.uri
+      end
+    end
+
+    context "Request.delete(path)" do
+      setup do
+        stub_delete(/.+/, success_response)
+        @response = ActiveForms::Request.delete("forms", :param => "value")
+      end
+
+      should "be equivalent to Request.new(:delete, path).perform" do
+        request = ActiveForms::Request.new(:delete, "forms", :param => "value")
+        assert_equal @response, request.perform
+      end
+    end
+  end
+end

data/test/active_forms_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class ActiveFormsTest < Test::Unit::TestCase
+  should "configure with block" do
+    ActiveForms.configure do |c|
+      c.url        = "AnUrl"
+      c.base_url   = "MyBaseUrl"
+      c.api_key    = "MyApiKey"
+      c.secret_key = "SuperSecret"
+    end
+
+    assert_equal "AnUrl",       ActiveForms.configuration.url
+    assert_equal "MyBaseUrl",   ActiveForms.configuration.base_url
+    assert_equal "MyApiKey",    ActiveForms.configuration.api_key
+    assert_equal "SuperSecret", ActiveForms.configuration.secret_key
+  end
+end

data/test/fixtures/error.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<error apiVersion="1.0" code="API_TIMESTAMP_INVALID" message="Api timestamp parameter value out of 15 minutes slot" requestMethod="GET" requestTimestamp="2010-02-18T16:31:53.060+01:00" requestURL="/client/dummies" xmlns="http://api.example.com"/>

data/test/fixtures/get_applicationdata.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<applicationData
+xmlns="http://api.activeforms.com"
+apiVersion="1.0"
+formCode="credit_card_application"
+formVersionCode="version_1"
+number="23456"
+date="2007-08-23T12:43:03"
+status="sent"
+isPrintable="true"
+>
+<fieldData identifier="last_name">
+<value>Kowalski</value>
+</fieldData>
+<fieldData identifier="typ_karty">
+<value>kredytowa</value>
+</fieldData>
+<fieldData identifier="ubezpieczenie">
+<value>ubezpieczenie_karty</value>
+<value>na_zycie</value>
+</fieldData>
+<fieldData identifier="przetwarzanie_danych">
+<value>YES</value>
+</fieldData>
+<fieldData identifier="data_urodzenia">
+<value>1978-01-12</value>
+</fieldData>
+<fieldData identifier="zdjecie">
+<value>moj_misio.jpg</value>
+<fileContent>/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
+HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
+MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAMABAADASIA</fileContent>
+</fieldData>
+<fieldData identifier="nr_telefonu">
+<value>+48 22 1234567</value>
+</fieldData>
+<fieldData identifier="uwagi"/>
+</applicationData>

data/test/fixtures/get_applicationprint.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<applicationPrint
+xmlns="http://api.activeforms.com"
+apiVersion="1.0"
+formCode="credit_card_application"
+formVersionCode="version_1"
+number="23456"
+date="2007-08-23T12:43:03"
+status="sent"
+contentType="application/pdf"
+>
+<printContent>
+/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAMABAADASIA
+</printContent>
+</applicationPrint>

data/test/fixtures/get_applications.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<applications
+xmlns="http://api.activeforms.com"
+apiVersion="1.0"
+>
+<application
+number="12234"
+formCode="credit_card_application"
+formVersionCode="version_1"
+date="2007-08-23T12:43:03"
+status="sent"
+isPrintable="true"
+/>
+<application
+number="12235"
+formCode="credit_card_application"
+formVersionCode="version_1"
+date="2007-08-23T12:44:03"
+status="sent"
+isPrintable="true"
+/>
+</applications>

data/test/fixtures/get_applications_single.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<applications
+xmlns="http://api.activeforms.com"
+apiVersion="1.0"
+>
+<application
+number="12234"
+formCode="credit_card_application"
+formVersionCode="version_1"
+date="2007-08-23T12:43:03"
+status="sent"
+isPrintable="true"
+/>
+</applications>

data/test/fixtures/get_forms.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<forms
+xmlns="http://api.activeforms.com"
+apiVersion="1.0"
+>
+<form
+name="Wniosek o~karte kredytowa"
+code="credit_card_application"
+url="https://www.activeforms.com/mybank/wniosek_o_karte_kredytowa"
+status="active"
+activeReleaseCode="version_1"
+activeReleaseName="Wersja pierwsza"
+title="Wniosek o~karte kredytowa"
+isPrintAgreement="isPrintable"
+/>
+<form
+name="Wniosek o~kredyt hipoteczny"
+code="mortgage_credit"
+url="https://www.activeforms.com/mybank/wniosek_o_kredyt_hipoteczny"
+status="inactive"
+/>
+</forms>

data/test/fixtures/get_forms_single.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<forms
+xmlns="http://api.activeforms.com"
+apiVersion="1.0"
+>
+<form
+name="Wniosek o~kredyt hipoteczny"
+code="mortgage_credit"
+url="https://www.activeforms.com/mybank/wniosek_o_kredyt_hipoteczny"
+status="inactive"
+/>
+</forms>

data/test/fixtures/success.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<dummies apiVersion="1.1" xmlns="http://api.example.com/1.1">
+  <dummy name="pit" aCode="pitcode" />
+</dummies>

data/test/test_helper.rb

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'active_forms'
+
+FakeWeb.allow_net_connect = false
+
+class Test::Unit::TestCase
+  def teardown
+    FakeWeb.clean_registry
+  end
+
+  def configure
+    ActiveForms.configure do |c|
+      c.api_url    = { :protocol => "https", :host => "api.example.com" }
+      c.url        = { :protocol => "https", :host => "www.example.com" }
+      c.base_url   = "client"
+      c.api_key    = "123456"
+      c.secret_key = "abcdef"
+    end
+  end
+
+  def assert_same_uri(expected, actual)
+    expected ||= ""
+    actual   ||= ""
+    expected_url, expected_params = expected.split('?', 2)
+    actual_url, actual_params     = actual.split('?', 2)
+    expected_params = expected_params.to_s.split('&')
+    actual_params   = actual_params.to_s.split('&')
+
+    assert_equal expected_url, actual_url, "urls are not equal"
+    assert_same_elements expected_params, actual_params, "params are not equal"
+  end
+
+  def stub_get(uri, response = {})
+    FakeWeb.register_uri(:get, uri, response)
+  end
+
+  def stub_post(uri, response = {})
+    FakeWeb.register_uri(:post, uri, response)
+  end
+
+  def stub_delete(uri, response = {})
+    FakeWeb.register_uri(:delete, uri, response)
+  end
+
+  def success_response(file = nil)
+    response = {
+      :status       => ["200", "OK"],
+      :content_type => "text/xml",
+      :body         => fixture(file || "success")
+    }
+  end
+
+  def error_response(file = nil)
+    response = {
+      :status       => ["401", "Unauthorized"],
+      :content_type => "text/xml",
+      :body         => fixture(file || "error")
+    }
+  end
+
+  def fixture(file)
+    File.read(File.join(File.dirname(__FILE__), "fixtures", "#{file}.xml"))
+  end
+end
+
+def define_mapper(klass)
+  Object.const_set(klass, Class.new(ActiveForms::Mapper))
+  case klass
+  when "Dummy"
+    Dummy.class_eval  do
+      columns :name, :formCode
+    end
+  end
+end
+
+def reset_mapper(klass)
+  Object.send(:remove_const, klass) rescue nil
+  define_mapper(klass)
+end
+
+define_mapper("Dummy")

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: active_forms
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- "Micha\xC5\x82 Szajbe"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+description: 
+email: michal.szajbe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- active_forms.gemspec
+- lib/active_forms.rb
+- lib/active_forms/application.rb
+- lib/active_forms/application_print.rb
+- lib/active_forms/configuration.rb
+- lib/active_forms/form.rb
+- lib/active_forms/mapper.rb
+- lib/active_forms/request.rb
+- test/active_forms/application_print_test.rb
+- test/active_forms/application_test.rb
+- test/active_forms/form_test.rb
+- test/active_forms/mapper_test.rb
+- test/active_forms/request_test.rb
+- test/active_forms_test.rb
+- test/fixtures/error.xml
+- test/fixtures/get_applicationdata.xml
+- test/fixtures/get_applicationprint.xml
+- test/fixtures/get_applications.xml
+- test/fixtures/get_applications_single.xml
+- test/fixtures/get_forms.xml
+- test/fixtures/get_forms_single.xml
+- test/fixtures/success.xml
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/monterail/active_forms
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Active Forms API wrapper
+test_files: 
+- test/active_forms/application_print_test.rb
+- test/active_forms/application_test.rb
+- test/active_forms/form_test.rb
+- test/active_forms/mapper_test.rb
+- test/active_forms/request_test.rb
+- test/active_forms_test.rb
+- test/test_helper.rb