simplificator-billboard-api 0.4.0 → 0.6.1

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.6.1

data/billboard-api.gemspec

@@ -1,15 +1,12 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{billboard-api}
-  s.version = "0.4.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["simplificator"]
-  s.date = %q{2009-08-14}
+  s.date = %q{2009-08-25}
   s.description = %q{Billboard-API is needed to add the additional models for the billboard application.}
   s.email = %q{info@simplificator.com}
   s.extra_rdoc_files = [
@@ -25,28 +22,32 @@ Gem::Specification.new do |s|
      "VERSION",
      "billboard-api.gemspec",
      "lib/billboard-api.rb",
+     "lib/billboard-api/config.rb",
      "lib/billboard-api/currency.rb",
      "lib/billboard-api/customer.rb",
+     "lib/billboard-api/default_config.rb",
      "lib/billboard-api/order.rb",
      "lib/billboard-api/payment_method.rb",
      "lib/billboard-api/tax.rb",
      "test/billboard-api_test.rb",
+     "test/config_test.rb",
      "test/test_helper.rb"
   ]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/simplificator/billboard-api}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.2}
   s.summary = %q{TODO: one-line summary of your gem}
   s.test_files = [
     "test/billboard-api_test.rb",
+     "test/config_test.rb",
      "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])

data/lib/billboard-api.rb

@@ -1,5 +1,8 @@
-require File.join(File.dirname(__FILE__), 'billboard-api', 'order')
-require File.join(File.dirname(__FILE__), 'billboard-api', 'customer')
-require File.join(File.dirname(__FILE__), 'billboard-api', 'payment_method')
-require File.join(File.dirname(__FILE__), 'billboard-api', 'currency')
-require File.join(File.dirname(__FILE__), 'billboard-api', 'tax')
+require 'rubygems'
+require 'activeresource'
+require 'singleton'
+
+%w[order customer payment_method currency tax config default_config].each do |name|
+  require File.join(File.dirname(__FILE__), 'billboard-api', name)
+end
+

data/lib/billboard-api/config.rb

@@ -0,0 +1,83 @@
+module BillboardApi
+  
+  #
+  # Following Settings are required:
+  #  * return_after_payment_url
+  #  * paypal_service_url
+  #  * paypal_notify_url
+  #  * paypal_receiver_email
+  #  * site_url
+  
+  
+  #
+  # Config is a singleton instance which can be used in two ways:
+  # Config.instance.setting_name1 = 12
+  # Config.instance.setting_name2 = 24
+  # or the (shorter, depending on amount of settings) form with a block
+  # Config.configure do |config|
+  #  config.setting_name1= 12
+  #  config.setting_name2= 24
+  # end 
+  #
+  #
+  # the accessors have possibility to override
+  # settings. This is useful for custom settings on a lower level
+  #
+  # config.setting_name1(12)
+  # => will return 12 all the time which does not make much sense...
+  # config.setting_name(options[:override_setting_name1]) will return the not-nil value from options has
+  # or the setting stored in config.
+  #
+  class Config
+    include Singleton
+    
+    REQUIRED_SETTINGS = [:return_after_payment_url, :paypal_service_url, :paypal_notify_url, :paypal_receiver_email, :site_url]
+    
+    # Overwrite site urls since they are directly applied to the 
+    # Order class' class variable 'site'
+    def site_url(override = nil)
+      override || ActiveResource::Base.site
+    end
+    def site_url=(value)
+      ActiveResource::Base.site= value
+    end
+        
+    # Allow access for arbitrary settings    
+    def method_missing(m, *args)
+      if !m.to_s.ends_with?('=') && args.length <= 1
+        # return override or setting
+        args.first || settings[m.to_s]
+      elsif m.to_s.ends_with?('=') && args.length == 1
+        settings[m.to_s[0...-1]] = args.first
+      else
+        super(m, args)
+      end
+    end
+    
+    # Helper method to ensure all settings are present.
+    # Will raise a StandardError if Config is invalid.
+    def validate!
+      REQUIRED_SETTINGS.each do |name|
+        raise "Settings '#{name}' is required. Use 'Config.instance.#{name}= VALUE' to set a value" unless self.send(name) 
+      end
+    end
+ 
+    def clear!
+      @settings = {}
+      site_url = nil
+      nil
+    end
+    
+    # Configure with a block
+    # will yield the instance of Config to the block.
+    def self.configure(&block)
+      config = Config.instance
+      yield(instance) if block_given?
+    end
+    
+    private
+    def settings
+      @settings ||= {}
+    end
+  end
+end

data/lib/billboard-api/currency.rb

@@ -1,5 +1,5 @@
 module BillboardApi
   class Currency < ActiveResource::Base
-    self.site = "http://billboard.garden.u2.simplificator.com"
+#    self.site = "http://billboard.garden.u2.simplificator.com"
   end
 end

data/lib/billboard-api/customer.rb

@@ -1,5 +1,5 @@
 module BillboardApi
   class Customer < ActiveResource::Base
-    self.site = "http://billboard.garden.u2.simplificator.com"
+#    self.site = "http://billboard.garden.u2.simplificator.com"
   end
 end

data/lib/billboard-api/default_config.rb

@@ -0,0 +1,20 @@
+puts "default config"
+BillboardApi::Config.configure do |config|
+  
+  # if running from rails, then set values depending on environment
+  if defined? RAILS_ENV
+    if RAILS_ENV == 'test'
+      config.paypal_service_url = "https://www.sandbox.paypal.com/cgi-bin/webscr?"
+    elsif RAILS_ENV == 'development'
+      config.paypal_service_url = "https://www.sandbox.paypal.com/cgi-bin/webscr?"
+    elsif RAILS_ENV == 'staging'
+      config.paypal_service_url = "https://www.sandbox.paypal.com/cgi-bin/webscr?"
+    elsif RAILS_ENV == 'production'
+      config.paypal_service_url = "https://www.paypal.com/cgi-bin/webscr?"
+    end
+  else 
+    puts "Not in rails, no defaults set"
+  end
+  # default values
+  config.site_url = 'http://billboard.garden.u2.simplificator.com'
+end

data/lib/billboard-api/order.rb

@@ -1,5 +1,42 @@
 module BillboardApi
   class Order < ActiveResource::Base
-    self.site = "http://billboard.garden.u2.simplificator.com"
+    
+    # Create an URL which can be used to redirect the client to paypal.
+    # It will include information about the order (id), amount, currency and so on.
+    # Some options can be overriden by using the options hash.
+    #  * paypal_notify_url
+    #  * paypal_receiver_email
+    #  * return_after_payment_url
+    # 
+    def paypal_url(options = {})
+       values = {
+         :business => BillboardApi::Config.instance.paypal_receiver_email(options[:paypal_receiver_email]),
+         :return => BillboardApi::Config.instance.return_after_payment_url(options[:return_after_payment_url]),
+         :invoice => self.id,
+         :cmd => '_cart',
+         :upload => 1,
+         :currency_code => self.currency,
+       }
+       values[:notify_url] = BillboardApi::Config.instance.paypal_notify_url(options[:paypal_notify_url])
+
+       self.line_items_attributes.each_with_index do |line_item, index|
+         values.merge!({
+           "amount_#{index + 1}" => "%0.2f" % line_item.price_francs.to_f,
+           "item_name_#{index + 1}" => line_item.description,
+           "item_number_#{index + 1}" => line_item.id,
+           "quantity_#{index + 1}" => line_item.amount
+         })
+       end
+
+       unless self.vat_total == 0
+         values.merge!({
+           "amount_#{self.line_items.size + 1}" => "%0.2f" % (self.vat_total.to_f / 100),
+           "item_name_#{self.line_items.size + 1}" => "MwSt.",
+           "quantity_#{self.line_items.size + 1}" => 1
+         })
+       end
+       
+       "#{BillboardApi::Config.instance.paypal_service_url}?#{values.to_query}"
+     end
   end
 end

data/lib/billboard-api/tax.rb

@@ -1,5 +1,4 @@
 module BillboardApi
   class Tax < ActiveResource::Base
-    self.site = "http://billboard.garden.u2.simplificator.com"
   end
 end

data/test/config_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'uri'
+class ConfigTest < Test::Unit::TestCase
+  include BillboardApi
+  def setup
+    @config = Config.instance
+    @config.clear!
+  end
+  should "Return nil on unknown config" do
+        assert_equal nil, @config.test_property
+      end
+      
+      should 'return the value upon set operation' do
+        assert 'test', (@config.test_property= 'test')
+      end
+      
+  should 'store and return a setting' do
+    assert 'test', (@config.test_property= 'test')
+    assert 'test', @config.test_property
+  end
+  
+  should 'update an existing property' do
+    assert 'bla', (@config.test_property= 'bla')
+    assert 'bla', @config.test_property
+    assert 'test', (@config.test_property= 'test')
+    assert 'test', @config.test_property
+  end
+  
+  
+  should 'Allow configuration trough block' do
+    Config.configure do |conf|
+      conf.foobar= 'http://foo.bar'
+    end
+    assert_equal 'http://foo.bar', @config.foobar
+  end
+  
+  
+  should 'allow override of setting' do
+    @config.bla = 12
+    assert_equal 13, @config.bla(13)
+  end
+  
+  should 'validate! only if all required settings are present' do
+    assert_raises RuntimeError do
+      Config.instance.validate!  
+    end
+    Config.configure do |config|
+      config.return_after_payment_url= '1'
+      config.paypal_service_url= 2
+      config.paypal_notify_url= 3
+      config.paypal_receiver_email= 4
+      config.site_url = 'http://localhost:3000'
+    end
+    Config.instance.validate!
+  end
+  
+  should 'set site_url to Tax and Order' do
+      Config.instance.site_url = 'http://foo.bar.com'
+      assert_equal 'http://foo.bar.com', Order.site.to_s
+      assert_equal 'http://foo.bar.com', Tax.site.to_s
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-billboard-api
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - simplificator
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-14 00:00:00 -07:00
+date: 2009-08-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,12 +40,15 @@ files:
 - VERSION
 - billboard-api.gemspec
 - lib/billboard-api.rb
+- lib/billboard-api/config.rb
 - lib/billboard-api/currency.rb
 - lib/billboard-api/customer.rb
+- lib/billboard-api/default_config.rb
 - lib/billboard-api/order.rb
 - lib/billboard-api/payment_method.rb
 - lib/billboard-api/tax.rb
 - test/billboard-api_test.rb
+- test/config_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/simplificator/billboard-api
@@ -72,8 +75,9 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: "TODO: one-line summary of your gem"
 test_files: 
 - test/billboard-api_test.rb
+- test/config_test.rb
 - test/test_helper.rb