2Performant 0.0.1 → 0.0.2

data/2Performant.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{2Performant}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["2Performant"]
-  s.date = %q{2010-04-29}
+  s.date = %q{2010-05-04}
   s.description = %q{Library for the 2Performant API}
   s.email = %q{andrei@2performant.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "2Performant.gemspec",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "lib/two_performant.rb",

data/README.md

@@ -0,0 +1,55 @@
+# 2Performant Ruby API
+
+The API allows you to integrate any 2Performant network in your application.
+
+Its goal is to make sure developers can implement anything that can be done via the web interface using API functions.
+
+The API is RESTful XML over HTTP using all four verbs (GET/POST/PUT/DELETE).
+
+The current implementation is a straight port of the PHP library, so the documentation applies, for the most part, to both libraries.
+
+API documentation can be found at:
+http://help.2performant.com/API
+
+
+## Some Examples
+
+Interacting with 2Performant networks is very easy.
+
+
+To initialize the object using simple authentication
+  
+    session = TwoPerformant.new(:simple, {
+      :user => 'user',
+      :pass => 'password',
+    }, 'http://api.yournetwork.com')
+
+To use oauth
+
+    tp = TwoPerformant.new(:oauth, {
+      :consumer_token => 'consumer_token',
+      :consumer_secret => 'consumer_secret',
+      :access_token => 'access_token',
+      :access_secret => 'access_secret'
+    }, 'http://api.yournetwork.com')
+
+
+Afterwards you can call any function from the TPerformant class:
+
+    # display the last 6 received messages
+    p session.received_messages_list
+
+For details about each API function the documentation can be found at:
+http://help.2performant.com/API
+
+
+## Advanced Applications
+
+You can build advanced applications using the 2Performant API and have them distributed over 2Performant App Store. 
+
+Get Started at: http://apps.2performant.com and http://help.2performant.com/Developers-Area
+
+## Reporting Problems
+
+If you encounters any problems don't hesitate to contact us at:
+support (at) 2performant.com

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/two_performant.rb

@@ -3,6 +3,9 @@ require 'two_performant/oauth'
 
 class TwoPerformant
   include HTTParty
+  format :xml
+  headers 'Content-Type' => 'text/xml'
+
   attr_accessor :user, :pass, :host, :version, :auth_type, :oauth, :oauth_request
 	
 	def initialize(auth_type, auth_obj, host) 
@@ -14,6 +17,7 @@ class TwoPerformant
       return false
     end
 
+    self.version = "v1.0"
     self.auth_type = auth_type
     self.host = host
     self.class.base_uri host
@@ -258,7 +262,12 @@ class TwoPerformant
 
   #  
   # Merchants: Create Text Link. 
-  # Txtlink must look like: array("title" => "title", "url" => "url", "help" => "help");  where "help" is optional
+  #
+  # Txtlink must be a hash of:
+  #   { "title" => "title",
+  #     "url" => "url",
+  #     "help" => "help"
+  #   },  where "help" is optional
   
   def txtlink_create(campaign_id, txtlink) 
     request = {
@@ -314,8 +323,12 @@ class TwoPerformant
 
   #  
   # Merchants: Create Text Ad. 
-  # Txtad must look like: array("title" => "title", "content" => "content", "url" => "url", "help" => "help");  where "help" is optional
-  
+  # Txtad must be a hash of:
+  #   { "title" => "title",
+  #     "content" => "content",
+  #     "url" => "url",
+  #     "help" => "help"
+  #   },  where "help" is optional
   def txtad_create(campaign_id, txtad) 
     request = {
       'txtad' => txtad
@@ -459,11 +472,18 @@ class TwoPerformant
 
   #  
   # Merchants: Create a WidgetStoreProduct. 
-  # WidgetStoreProduct must look like: 
-  # array("title" => "title", "description" => "desc", "caption" => "caption", "price" => "price(integer in RON)", 
-  # "promoted" => "promoted (0 or 1)", "category" => "category", "subcategory" => "subcategory",  "url" => "url", 
-  # "image_url" => "url to image location", "prid" => "product id")
-  
+  # WidgetStoreProduct must be a hash of: 
+  #   { "title" => "title",
+  #     "description" => "desc",
+  #     "caption" => "caption",
+  #     "price" => "price(integer in RON)", 
+  #     "promoted" => "promoted (0 or 1)",
+  #     "category" => "category",
+  #     "subcategory" => "subcategory", 
+  #     "url" => "url", 
+  #     "image_url" => "url to image location",
+  #     "prid" => "product id"
+  #   }
   def product_store_createitem(product_store_id, product) 
     request = {
       'product' => product
@@ -555,24 +575,38 @@ class TwoPerformant
   end
 
 
-  # ===========================
-  #  Actually process the data 
-  # ===========================
-	
-	def hook(path, expected, send = nil, method = 'GET') 
+	def hook(path, expected, send = nil, method = 'GET') #:nodoc:
+    params = normalize_params(send, method)
+    
     if self.oauth
-      result = self.oauth.send(method.downcase, path, send)
+      result = self.oauth.send(method.downcase, "/#{version}#{path}", send, params)
     else
-      result = self.class.send(method.downcase, path, :query => send)
+      result = self.class.send(method.downcase, "/#{version}#{path}", :body => params)
     end
 
     # scrap the container
-    result.values.first
+    if result.respond_to? :values
+      result.values.first 
+    else
+      result
+    end
 	end
-	
-  def simpleHttpRequest(url, params, method) 
+
+  def normalize_params(params, method)
+    hash_to_xml(:request => params).to_s
   end
 
-  def oauthHttpRequest(url, params, method) 
+  def hash_to_xml(var, document = nil)
+    document = REXML::Document.new if document.nil?
+
+    if var.respond_to? :keys
+      var.keys.each do |key|
+        hash_to_xml(var[key], document.add_element(key.to_s))
+      end
+    else
+      document.add_text(var.to_s)
+    end
+
+    document
   end
 end

data/lib/two_performant/oauth.rb

@@ -7,28 +7,26 @@ class TwoPerformant
     def initialize(options, host)
       consumer = ::OAuth::Consumer.new(options[:consumer_token], options[:consumer_secret], {:site => host})
       @access_token = ::OAuth::AccessToken.new(consumer, options[:access_token], options[:access_secret])
+      @headers = { 'Accept' => 'application/xml', 'Content-Type' => 'application/xml' }
     end
 
-    def get(path, params) 
-      params ||= {}
-      response = access_token.get("#{path}?#{params.to_params}")
+    def get(path, params_hash, params_xml) 
+      params_hash ||= {}
+      response = access_token.get("#{path}?#{params_hash.to_params}")
       Crack::XML.parse(response.body)
     end
 
-    def post(path, params) 
-      params ||= {}
-      response = access_token.post(path, params)
+    def post(path, params_hash, params_xml) 
+      response = access_token.post(path, params_xml, @headers)
       Crack::XML.parse(response.body)
     end
 
-    def put(path, params) 
-      params ||= {}
-      response = access_token.put(path, params)
+    def put(path, params_hash, params_xml) 
+      response = access_token.put(path, params_xml, @headers)
       Crack::XML.parse(response.body)
     end
 
     def delete(path, params) 
-      params ||= {}
       response = access_token.delete("#{path}?#{params.to_params}")
       Crack::XML.parse(response.body)
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - 2Performant
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 +03:00
+date: 2010-05-04 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,13 +49,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - 2Performant.gemspec
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/two_performant.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= 2performant
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 2Performant. See LICENSE for details.