active_forms 0.2.1 → 0.3.0

data/.gitignore

@@ -1,21 +1,17 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
 coverage
-rdoc
+doc/
+lib/bundler/man
 pkg
-
-## PROJECT::SPECIFIC
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: "rake test"
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_forms.gemspec
+gemspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2009 Michał Szajbe
+Copyright (c) 2009 Monterail.com
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,31 @@
+[![Build Status](https://secure.travis-ci.org/monterail/active_forms.png?branch=master)](http://travis-ci.org/monterail/active_forms)
+
+# ActiveForms
+
+ActiveForms API wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_forms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_forms
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2009 Monterail.com. See LICENSE for details.

data/Rakefile

@@ -1,55 +1,9 @@
-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
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.test_files = Dir.glob("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/active_forms.gemspec

@@ -1,86 +1,21 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_forms/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{active_forms}
-  s.version = "0.2.1"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Micha\xC5\x82 Szajbe"]
+  gem.email         = ["michal.szajbe@gmail.com"]
+  gem.summary       = %q{Active Forms API wrapper}
+  gem.homepage      = "http://github.com/monterail/active_forms"
 
-  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"
-  ]
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "active_forms"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveForms::VERSION
 
-  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
+  gem.add_runtime_dependency "activesupport", ">= 0"
+  gem.add_runtime_dependency "httparty", ">= 0.5.2"
+  gem.add_development_dependency "thoughtbot-shoulda", ">= 2.10.2"
+  gem.add_development_dependency "fakeweb", ">= 1.2.8"
 end
-

data/lib/active_forms.rb

@@ -1,12 +1,22 @@
+# encoding: UTF-8
+
 require 'active_support'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/string/starts_ends_with'
 
 require 'active_forms/configuration'
 require 'active_forms/mapper'
 require 'active_forms/request'
+require 'active_forms/version'
 
 require 'active_forms/application'
 require 'active_forms/application_print'
+require 'active_forms/entry'
+require 'active_forms/entry_printout'
 require 'active_forms/form'
+require 'active_forms/form_version'
+require 'active_forms/token'
 
 module ActiveForms
   class << self
@@ -16,21 +26,37 @@ module ActiveForms
       self.configuration ||= Configuration.new
       yield(configuration)
     end
+
+    def log(msg)
+      if configuration.logger
+        configuration.logger.info(msg)
+      end
+    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
+  class Error < StandardError; end
+
+  class ApiKeyInvalid             < Error; end
+  class ApiSigInvalid             < Error; end
+  class ApiTimestampInvalid       < Error; end
+  class ApiVersionNotSupported    < Error; end
+  class ApplicationNotFound       < Error; end
+  class ApplicationNotSent        < Error; end
+  class BadParameterFormat        < Error; end
+  class FieldNotFound             < Error; end
+  class FieldNotMultiple          < Error; end
+  class Forbidden                 < Error; end
+  class FormActiveVersionNotFound < Error; end
+  class FormNotFound              < Error; end
+  class FormVersionNotFound       < Error; end
+  class InternalServerError       < Error; end
+  class MethodNotAllowed          < Error; end
+  class MissingParameter          < Error; end
+  class MissingResource           < Error; end
+  class MissingVendor             < Error; end
+  class NullResponse              < Error; end
+  class OptionNotFound            < Error; end
+  class ResourceNotSupported      < Error; end
+  class TemplateNotFound          < Error; end
+  class Unauthorized              < Error; end
 end

data/lib/active_forms/application.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 class ActiveForms::Application < ActiveForms::Mapper
   columns :number, :formCode, :formVersion, :date, :status, :isPrintable, :fieldData
 
@@ -10,7 +12,7 @@ class ActiveForms::Application < ActiveForms::Mapper
       hashes = response["applications"]["application"]
       hashes = [hashes] if hashes.is_a?(Hash)
 
-      objects = hashes.map { |attributes| new(attributes) }
+      objects = hashes.nil? ? [] : hashes.map { |attributes| new(attributes) }
     end
 
     # required params:

data/lib/active_forms/application_print.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 class ActiveForms::ApplicationPrint < ActiveForms::Mapper
   columns :formCode, :formVersionCode, :number, :date, :status, :contentType, :printContent
 

data/lib/active_forms/configuration.rb

@@ -1,6 +1,8 @@
+# encoding: UTF-8
+
 module ActiveForms
   class Configuration
-    attr_accessor :api_url, :url, :base_url, :api_key, :secret_key
+    attr_accessor :api_url, :url, :base_url, :api_key, :secret_key, :logger
 
     def initialize
       @api_url = { :protocol => "https", :host => 'api.activeforms.com' }

data/lib/active_forms/entry.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+class ActiveForms::Entry < ActiveForms::Mapper
+  columns :number, :formCode, :formVersionCode, :date, :status, :isPrintable, :fieldData, :accessToken
+
+  class << self
+
+    def all(params = {})
+      response = ActiveForms::Request.get("entries", params)
+
+      hashes = response["entries"]["entry"]
+      hashes = [hashes] if hashes.is_a?(Hash)
+
+      objects = hashes.nil? ? [] : hashes.map { |attributes| new(attributes) }
+    end
+
+    # required params:
+    #   apiFormCode                 - form's code
+    #   apiNumber or apiEntryToken  - entry's number or token
+    def find(params = {})
+      response = ActiveForms::Request.get("entrydata", params)
+
+      attributes = response["entryData"]
+
+      new(attributes)
+    end
+
+    # required params:
+    #   apiFormCode
+    #   field id
+    def create(params = {})
+      response = ActiveForms::Request.post("entrydata", params)
+
+      attributes = response["entryPutConfirmation"]
+
+      new(attributes)
+    end
+
+    # required params:
+    #   apiFormCode
+    #   apiNumber or apiEntryToken
+    def delete(params = {})
+      response = ActiveForms::Request.delete("entrydata", params)
+      response && response.code.to_i == 204
+    end
+  end
+
+  def destroy
+    ActiveForms::Entry.delete :apiFormCode => self.formCode, :apiNumber => self.number
+  end
+end

data/lib/active_forms/entry_printout.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+class ActiveForms::EntryPrintout < ActiveForms::Mapper
+  columns :formCode, :formVersionCode, :number, :date, :status, :contentType, :identifier, :printoutContent
+
+  class << self
+    # required params:
+    #   apiFormCode - Form's code
+    #   apiNumber   - Application's number
+    def find(params = {})
+      response = ActiveForms::Request.get("entryprintout", params)
+
+      attributes = response["entryPrintout"]
+
+      new(attributes)
+    end
+  end
+
+  def printoutContent=(value)
+    @attributes["printoutContent"] = value.is_a?(String) ? value.strip : super
+  end
+end