zanox 0.1.0 → 0.2.0

metadata

@@ -1,60 +1,95 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: zanox
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2009-07-13 00:00:00 +02:00
-summary: Ruby wrapper around Zanox API.
-require_paths: 
-- lib
-email: 
-homepage: http://wiki.zanox.com/
-rubyforge_project: 
-description: Ruby Client Library.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
-- Chi-Dong Ly
-files: 
-- README.txt
-- License.txt
-- lib/zanox.rb
-- lib/zanox/zanox_base.rb
-- lib/zanox/zanox_xml.rb
-- lib/zanox/zanox_json.rb
-- lib/zanox/zanox_soap.rb
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+- Krispin Schulz
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2010-05-07 00:00:00 +02:00
+default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: soap4r
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 8
+        version: 1.5.8
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: ruby-hmac
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.2
-    version: 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id002
+description: The easy way to the zanox web services.
+email: krispinone@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- Rakefile
+- zanox.gemspec
+- README.textile
+- lib/zanox.rb
+- test/zanox_tests.rb
+- spec/zanox_specs.rb
+has_rdoc: true
+homepage: http://kr1sp1n.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: One gem to rule the zanox web services.
+test_files: 
+- test/zanox_tests.rb

data/License.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Chi-Dong Ly
-
-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.txt

@@ -1,82 +0,0 @@
-= Zanox.rb
-
-* Rubyforge profile: http://zanox.rubyforge.org
-* Source code repository: 
-
-== DESCRIPTION:
-
-Ruby wrapper around Zanox.com[http://www.zanox.com] API.
-
-== FEATURES:
-
-Currently implemented API methods:
-
-* get_adspaces
-* get_adspace
-* delete_adspace
-* get_program
-* get_programs
-* search_programs
-* get_program_news
-* get_program_categories
-* get_programs_by_adspace
-* delete_program_application
-* get_product
-* get_products_by_program
-* search_products
-* get_admedium
-* get_admedia_by_program
-* get_admedia_categories_by_program
-* get_sales
-* get_leads
-* get_payments
-* get_payment
-* get_balances
-* get_balance
-* get_accounts
-* get_account
-* get_profile
-
-  
-== NOT YET IMPLEMENTED:
-
-* create and update methods
-  
-== REQUIREMENTS:
-
-* active_support[http://rubyforge.org/projects/activesupport/]
-* rest-client[http://rubyforge.org/projects/rest-client/]
-* mime-types[http://rubyforge.org/projects/mime-types/]
-
-== INSTALL:
-
-* sudo gem install zanox
-
-== CONTACT:
-
-* chi-dong.ly@palabea.com
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 Chi-Dong Ly
-
-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/lib/zanox/zanox_base.rb

@@ -1,48 +0,0 @@
-require 'hmac-sha1'
-require 'base64' 
-
-module Zanox
-  
-  class ZanoxBase
-    
-    attr_accessor :timestamp
-    attr_reader :application_id, :last_error_msg
-    attr_writer :version
-    
-    def initialize(version = false)
-      @version = version
-      @application_id = ''
-      @shared_key = ''
-      @timestamp = false
-      @version = false
-      @api_security = false
-      @last_error_msg = false
-    end
-    
-    def set_message_credentials(application_id, shared_key)
-      @application_id = application_id
-      @shared_key     = shared_key
-    end
-
-    protected
-
-    def get_hmac_signature(mesgparams)
-      hmac = Base64.encode64(HMAC::SHA1.digest(@shared_key, mesgparams)).chomp
-      hmac
-    end
-
-    def enable_api_security
-      @api_security = true
-    end
-
-    def disable_api_security
-      @api_security = false
-    end
-
-    def get_timestamp
-
-    end
-    
-  end
-  
-end

data/lib/zanox/zanox_json.rb

@@ -1,19 +0,0 @@
-module Zanox
-  
-  class ZanoxJson < ZanoxXml
-    
-    def initialize(version = false)
-      @version = version
-      @rest_action = 'GET'
-      @url = 'http://api.zanox.com/json'
-      @content_type = 'application/json'
-      @raw_data_disabled = true
-    end
-    
-#    def serialize#TODO
-#      
-#    end
-    
-  end
-  
-end

data/lib/zanox/zanox_soap.rb

@@ -1,581 +0,0 @@
-require 'soap/wsdlDriver'
-
-module Zanox
-  
-  class ZanoxSoap < ZanoxBase
-    
-    attr_accessor :service, :wsdl, :soap
-    
-    def initialize
-      @service = 'publisherservice'
-      @wsdl = 'http://api.zanox.com/wsdl'
-      @soap = false
-    end
-    
-    def get_adspaces
-      method = 'GetAdspaces'
-        
-      enable_api_security
-
-      if result = send_request(method) 
-        return result
-      end
-
-      return false
-    end
-    
-    def get_adspace(adspace_id)
-      method = 'GetAdspace'
-        
-      params = {'adspaceId' => adspace_id.to_s }
-      
-      enable_api_security
-      
-      if result = send_request(method, params) 
-        return result
-      end
-
-      return false      
-    end
-    
-#    def create_adspace(adspace_item, lang = 'en')#FIXME
-#      method = 'CreateAdspace'
-#    end
-#    
-#    def update_adspace(adspace_id, adspace_item)#FIXME
-#      method = 'UpdateAdspace'
-#    end
-    
-    def delete_adspace(adspace_id)
-      method = 'DeleteAdspace'
-      
-      params = { 'adspaceId' => adspace_id.to_s }
-      
-      enable_api_security
-      
-      if send_request(method, params) 
-        return true
-      end
-
-      return false     
-    end
-    
-    def get_program(program_id)
-      method = 'GetProgram'
-        
-      params = { 'programId' => program_id.to_s }
-
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false
-    end
-
-    def get_programs(category_id = false, page = 0, items = 10)
-      method = 'GetPrograms'
-      
-      params = {
-        'page' => page,
-        'items' => items,
-        'adspaceId' => 0,
-        'categoryId' => 0
-      }
-      
-      if ( category_id )
-        params['categoryId'] = category_id.to_s
-      end
-
-      disable_api_security
-        
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false          	
-    end
-    
-    def search_programs(q, page = 0, items = 10)
-      method = 'SearchPrograms'
-        
-      params = {
-        'query' => q,
-        'page' =>  page,
-        'items' => items,
-        'categoryId' => 0
-      }
-
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false          
-    end
-    
-    def get_program_news
-      method = 'GetProgramPromotions'
-
-      disable_api_security
-
-      if  result = send_request(method)
-        return result
-      end
-
-      return false 
-    end
-    
-    def get_program_categories
-      method = 'GetProgramCategories'
-      
-      disable_api_security
-
-      if  result = send_request(method)
-        return result
-      end
-
-      return false 
-    end
-    
-    def get_programs_by_adspace(adspace_id, page = 0, items = 10)
-      method = 'GetPrograms'
-        
-      params = {
-        'page' => page,
-        'items' => items,
-        'adspaceId' => adspace_id.to_s,
-        'categoryId' => 0
-      }
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false        
-    end
-    
-#    def create_program_application(program_id, adspace_id)#FIXME
-#      method = 'CreateProgramApplication'
-#    end
-    
-    def delete_program_application(program_id, adspace_id)#TODO test
-      method = 'DeleteProgramApplication'
-        
-      params = { 
-        'programId' => program_id.to_s, 
-        'adspaceId' => adspace_id.to_s
-      }
-
-      enable_api_security
-
-      if  send_request(method, params)
-          return true
-      end
-
-      return false     
-    end
-    
-    def get_product(zup_id)
-      method = 'GetProduct'
-        
-      params = {'zupId' => zup_id.to_s }
-
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false  
-    end
-    
-    def get_products_by_program(program_id, filter = {}, page = 0, items = 10)
-      method = 'GetProducts'
-        
-      params = { 
-        'programId' => program_id.to_s,
-        'page' => page,
-        'items' => items,
-        'adspaceId' => 0
-      } 
-
-      if ( !filter['adspace'].blank? )
-        params['adspaceId'] = filter['adspace']     
-      end
-      
-      if ( !filter['modified'].blank? )
-        params['modifiedDate'] = filter['modified']     
-      end       
-
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false    
-    end
-    
-    def search_products(q, filter = {}, page = 0, items = 10)
-      method = 'SearchProducts'
-        
-      params = {
-        'query' => q, 
-        'page' => page,
-        'items' => items,
-        'adspaceId' => 0 
-      }
-
-      if ( !filter['adspace'].blank? )
-        params['adspaceId'] = filter['adspace']     
-      end  
-
-      if ( !filter['region'].blank? &&  filter['region'].size == 2)
-        params['region'] = filter['region']     
-      end  
-      
-      if ( !filter['minprice'].blank? )
-        params['minPrice'] = filter['minprice']     
-      end 
-      
-      if ( !filter['maxprice'].blank? )
-        params['maxPrice'] = filter['maxprice']     
-      end 
-
-      if ( !filter['ip'].blank? )
-        params['ipAddress'] = filter['ip']     
-      end
-      
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false    
-    end
-    
-    def get_admedium(admedium_id)
-      method = 'GetAdmedium'
-        
-      params = { 
-        'admediaId' => admedium_id.to_s,
-        'adspaceId' => 0
-      }
-
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false   
-    end
-    
-    def get_admedia_by_program(program_id, filter = {}, page = 0, items = 10)
-      method = 'GetAdmedia'
-      
-      params = { 
-        'programId' => program_id.to_s, 
-        'page' => page,
-        'items' => items,
-        'categoryId' => 0,
-        'type' => 0,
-        'format' => 0,   
-        'adspaceId' => 0
-      }
-      
-      if ( !filter['adspace'].blank? )
-        params['adspaceId'] = filter['adspace']     
-      end
-
-      if ( !filter['category'].blank? )
-        params['goryId'] = filter['category']     
-      end
-
-      if ( !filter['type'].blank? )
-        params['type'] = filter['type']     
-      end
-      
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false   
-    end
-    
-    def get_admedia_categories_by_program(program_id)
-      method = 'GetAdmediumCategories'
-        
-      params = { 'programId' => program_id.to_s }
-
-      disable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false   
-    end
-    
-    def get_sales(filter = {}, page = 0, items = 10)
-      method = 'GetSales'
-        
-      params = { 
-        'page' => page,
-        'items' => items
-      }
-
-      if ( !filter['date'].blank? )
-        params['date'] = filter['date']     
-      end
-      
-      if ( !filter['modifieddate'].blank? )
-        params['modifieddate'] = filter['modifieddate']     
-      end
-      
-      if ( !filter['clickdate'].blank? )
-        params['clickdate'] = filter['clickdate']     
-      end
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false  
-    end
-    
-    def get_leads(filter = {}, page = 0, items = 10)
-      method = 'GetLeads'
-        
-      params = {
-        'page' => page,
-        'items' => items
-      }
-
-      if ( !filter['date'].blank? )
-        params['date'] = filter['date']     
-      end
-      
-      if ( !filter['modifieddate'].blank? )
-        params['modifieddate'] = filter['modifieddate']     
-      end
-      
-      if ( !filter['clickdate'].blank? )
-        params['clickdate'] = filter['clickdate']     
-      end
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false    
-    end
-    
-    def get_payments(page = 0, items = 10)
-      method = 'GetPayments'
-        
-      params = { 
-        'page' => page,
-        'items' => items
-      }
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false  
-    end
-    
-    def get_payment(payment_id)
-      method = 'GetPayments'
-        
-      params = { 'paymentId' => payment_id.to_s }
-
-      #just has to be set to false to work around the bug 
-      # 3 lines can be removed after fixing        
-      params['page'] = page
-      params['items'] = items      
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false         
-    end
-    
-    def get_balances
-      method = 'GetBalances'
-        
-      enable_api_security
-
-      if  result = send_request(method)
-        return result
-      end
-
-      return false     
-    end
-    
-    def get_balance(currency_code)
-      method = 'GetBalances'
-        
-      params = { 'currency' => currency_code }
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false        
-    end
-    
-    def get_accounts
-      method = 'GetAccounts'
-        
-      enable_api_security
-
-      if  result = send_request(method)
-        return result
-      end
-
-      return false       
-    end
-    
-    def get_account(account_id)
-      method = 'GetAccounts'
-        
-      params = { 'accountId' => account_id }
-
-      enable_api_security
-
-      if  result = send_request(method, params)
-        return result
-      end
-
-      return false    
-    end
-    
-    def get_profile
-      method = 'GetProfile'
-        
-      enable_api_security
-
-      if  result = send_request(method)
-        return result
-      end
-
-      return false   
-    end
-    
-#    def update_profile(profile_item)#FIXME
-#      method = 'UpdateProfile'
-#    end
-    
-    def get_timestamp
-      timestamp = Time.now.gmtime 
-      timestamp = timestamp.strftime("%Y-%m-%dT%H:%M:%S.000Z")
-      timestamp.to_s
-    end
-    
-    def send_request(method, params = {})
-      params['applicationId'] = @application_id
-
-      if @api_security
-        params['timestamp'] = get_timestamp
-        params['signature'] = build_signature(method)
-      end
-
-      begin
-        proxy = SOAP::WSDLDriverFactory.new(@wsdl).create_rpc_driver 
-        case method
-          when 'GetAdspaces'
-            res = proxy.GetAdspaces(params) 
-          when 'GetAdspace'
-            res = proxy.GetAdspace(params) 
-          when 'CreateAdspace'
-            res = proxy.CreateAdspace(params) 
-          when 'UpdateAdspace'
-            res = proxy.UpdateAdspace(params) 
-          when 'DeleteAdspace'
-            res = proxy.DeleteAdspace(params) 
-          when 'GetProgram'
-            res = proxy.GetProgram(params) 
-          when 'GetPrograms'
-            res = proxy.GetPrograms(params) 
-          when 'SearchPrograms'
-            res = proxy.SearchPrograms(params) 
-          when 'GetProgramPromotions'
-            res = proxy.GetProgramPromotions(params) 
-          when 'GetProgramCategories'
-            res = proxy.GetProgramCategories(params) 
-          when 'CreateProgramApplication'
-            res = proxy.CreateProgramApplication(params) 
-          when 'DeleteProgramApplication'
-            res = proxy.DeleteProgramApplication(params) 
-          when 'GetProduct'
-            res = proxy.GetProduct(params) 
-          when 'GetProducts'
-            res = proxy.GetProducts(params) 
-          when 'SearchProducts'
-            res = proxy.SearchProducts(params) 
-          when 'GetAdmedium'
-            res = proxy.GetAdmedium(params) 
-          when 'GetAdmedia'
-            res = proxy.GetAdmedia(params) 
-          when 'GetAdmediumCategories'
-            res = proxy.GetAdmediumCategories(params) 
-          when 'GetSales'
-            res = proxy.GetSales(params)
-          when 'GetLeads'
-            res = proxy.GetLeads(params)
-          when 'GetPayments'
-            res = proxy.GetPayments(params)
-          when 'GetBalances'
-            res = proxy.GetBalances(params)
-          when 'GetAccounts'
-            res = proxy.GetAccounts(params)
-          when 'GetProfile'
-            res = proxy.GetProfile(params)
-          when 'UpdateProfile'
-            res = proxy.UpdateProfile(params)
-        end
-        
-        return res
-      rescue Exception => e
-        @last_error_msg = e.to_s
-      end
-
-      return false
-    end
-    
-    private
-    
-    def build_signature(method)
-      sign = @service + method.downcase + get_timestamp
-
-      if hmac = get_hmac_signature(sign)
-        return hmac
-      end
-
-      return false
-    end  
-    
-  end
-  
-end