ebayer 1.1.0 → 1.2.0

data/README.rdoc

@@ -2,10 +2,11 @@
 
 Using ebayer is very simple. Please follow these beneath steps and we are all set to get the open ebay api working.
 
-ebay = Ebay.new("http://open.api.sandbox.ebay.com/shopping", "MethodName","response type", "version", "app id", "username")
+ebay = Ebayer::OpenEbay.new("GetUserProfile", "<app id>", "TESTUSER_magickbookseller")
+
 This init method will be futher improvised and will be configurable. Its just matter of time :)
 
-ebay.get_user_information
+ebay.user_information
 
 This method will retrive the user details
 

data/lib/ebayer/get_user_profile.rb

@@ -1,41 +1,55 @@
-class Ebay
-
-  attr_accessor :open_url, :callname, :response_encoding, :app_id, :user_id, :response
-
-
-  def initialize(open_url, callname, response_encoding, api_version,  app_id, user_id)
-    @open_url = open_url
-    @callname = callname
-    @response_encoding= response_encoding
-    @api_version = api_version
-    @app_id = app_id
-    @user_id = user_id
-  end
+module Ebayer
+    
+  class OpenEbay
+    EBAYOPENURL= "http://open.api.sandbox.ebay.com/shopping"
+    RESPONSEENCODING = "JSON"
+    APIVERSION = "721"
   
-
-
-  def url_definer
-    url = @open_url+"?callname=#{@callname}&responseencoding=#{@response_encoding}&appid=#{@app_id}&siteid=0&UserID=#{@user_id}&IncludeSelector=Details&version=#{@api_version}"
-    return url
-  end
-
-  def request_ebay
-    requested_url = self.url_definer
-    new_response = HTTParty.get(requested_url)
-    @response = self.response_parser(new_response.body)
-  end
-  
-  def response_parser(response_content)
-    Hashie::Mash.new(JSON(response_content))
-  end
-
-  def success?
-    self.response_content ? (self.response_content["Ack"] == "Success") : (self.response_content["Ack"] == "Failure")
-  end
-  
-  def user_information
-    self.request_ebay
+    attr_accessor :open_url, :callname, :response_encoding, :app_id, :user_id, :response
+
+    def initialize( callname, app_id, user_id)
+      @callname = callname
+      @app_id = app_id
+      @user_id = user_id
+    end
+
+    ##Defineing the url. URL should have all the required elements like following:
+    ##callname - Name of the method being called    
+    ##ResponseEncoding - Response format. XML, JSON, Text formats are allowed. For this version lets keep JSON
+    ##AppId  - Appid is generated on ebay. While in production ensure you are using production keys and not sandbox
+    ##ApiVersion - Version of api you are placing the call.
+
+    def url_definer
+      url = EBAYOPENURL+"?callname=#{@callname}&responseencoding=#{RESPONSEENCODING}&appid=#{@app_id}&siteid=0&UserID=#{@user_id}&IncludeSelector=Details&version=#{APIVERSION}"
+      return url
+    end
+
+    ##Placing request to ebay via httparty.
+   
+    def request_ebay
+      requested_url = self.url_definer
+      response = nil 
+      begin
+      new_response = HTTParty.get(requested_url)
+      rescue Timeout::Error
+        raise TimeoutError, "Ebay is currently unavailbale. Please try again later"
+      end
+      @response = self.response_parser(new_response.body)
+    end
+
+    ##response parsing from string to JSON and mashing it into hash format of access. The rails way!    
+    def response_parser(response_content)
+      Hashie::Mash.new(JSON(response_content))
+    end
+      
+    ##For all those who require just the information and do no require whole response. Just a handy method.
+    def user_information
+      self.request_ebay
+    end
   end
 
+  class EbayError < StandardError; end
+  class TimeoutError < EbayError; end
 
 end
+

metadata

@@ -1,144 +1,188 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ebayer
-version: !ruby/object:Gem::Version
-  version: 1.1.0
+version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
-authors:
+authors: 
 - kranthicu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-09 00:00:00.000000000 -04:00
+
+date: 2011-07-07 00:00:00 -04:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &79195040 !ruby/object:Gem::Requirement
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
         version: 2.3.0
-  type: :development
+  requirement: *id001
   prerelease: false
-  version_requirements: *79195040
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &79194770 !ruby/object:Gem::Requirement
+  name: rspec
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-  type: :development
+  requirement: *id002
   prerelease: false
-  version_requirements: *79194770
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &79194520 !ruby/object:Gem::Requirement
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
         version: 1.6.2
+  requirement: *id003
+  prerelease: false
+  name: jeweler
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
   prerelease: false
-  version_requirements: *79194520
-- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &79194260 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
   prerelease: false
-  version_requirements: *79194260
-- !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &79194000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
   prerelease: false
-  version_requirements: *79194000
-- !ruby/object:Gem::Dependency
   name: json
-  requirement: &79193750 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
   prerelease: false
-  version_requirements: *79193750
-- !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &79193480 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
   prerelease: false
-  version_requirements: *79193480
-- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &79193220 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: *79193220
 description: This gem intended to use Ebay API withint ruby/rails applications
 email: kranthicu@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - lib/ebayer.rb
 - lib/ebayer/get_user_profile.rb
 - LICENSE.txt
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/kranthicu/ebayer
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -800815533
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Ebay API now made easy for rubyists and rails
 test_files: []
+