client.rb in hoptoad-api-2.1.0

- old
+ new

@@ -1,17 +1,21 @@
-# Ruby lib for working with the Hoptoad API's XML interface.  
+# Ruby lib for working with the Hoptoad API's XML interface.
 # The first thing you need to set is the account name.  This is the same
 # as the web address for your account.
 #
 #   Hoptoad.account = 'myaccount'
 #
 # Then, you should set the authentication token.
 #
-#   Hoptoad.token = 'abcdefg'
+#   Hoptoad.auth_token = 'abcdefg'
 #
 # If no token or authentication info is given, a HoptoadError exception will be raised.
 #
+# If your account uses ssl then turn it on:
+#
+#   Hoptoad.secure = true
+#
 # For more details, check out the hoptoad docs at http://hoptoadapp.com/pages/api.
 #
 # Find errors
 #
 #   Errors are paginated. You get 25 at a time.
@@ -20,67 +24,154 @@
 #   with pagination:
 #   Hoptoad::Error.find(:all, :params => { :page => 2 })
 #
 #   find individual error by ID
 #   Hoptoad::Error.find(44) 
+#
+# Find *all* notices by error_id
+#
+#   notices = Hoptoad::Notice.all(1234) # 1234 == error id
+#
+# Find notice by id + error_id
+#
+#   notice = Hoptoad::Notice.find(12345, 1234) # 12345 == notice id, 1234 == error id
 
 module Hoptoad
-  class Error
+  class Base
     include HTTParty
     format :xml
-  
-    @@collection_path = '/errors.xml'
-    @@individual_collection_path = '/errors/'
     
-    def self.collection_path
-      @@collection_path
-    end
-  
-    def self.find(*args)
+    private
+    
+    def self.setup
       base_uri Hoptoad.account
       default_params :auth_token => Hoptoad.auth_token
       
       check_configuration
+    end
     
+    def self.check_configuration
+      raise HoptoadError.new('API Token cannot be nil') if default_options.nil? || default_options[:default_params].nil? || !default_options[:default_params].has_key?(:auth_token)
+      raise HoptoadError.new('Account cannot be nil') unless default_options.has_key?(:base_uri)
+    end
+    
+    def self.fetch(path, options)
+      response = get(path, { :query => options })
+      if response.code == 403
+        raise HoptoadError.new('SSL should be enabled - use Hoptoad.secure = true in configuration')
+      end
+      
+      Hashie::Mash.new(response)
+    end
+
+  end
+
+  class Error < Base
+
+    def self.find(*args)
+      setup
+      
       results = case args.first
         when Fixnum
           find_individual(args)
         when :all
           find_all(args)
         else
           raise HoptoadError.new('Invalid argument')
       end
-    
+      
       raise HoptoadError.new('No results found.') if results.nil?
       raise HoptoadError.new(results.errors.error) if results.errors
       
       results.group || results.groups
     end
-  
+
     def self.update(error, options)
-      check_configuration
-    
-      self.class.put("#{@collection_path}", options)
+      setup
+      
+      self.class.put(collection_path, options)
     end
-  
+
     private
-  
-    def self.check_configuration
-      raise HoptoadError.new('API Token cannot be nil') if default_options.nil? || default_options[:default_params].nil? || !default_options[:default_params].has_key?(:auth_token)
-      raise HoptoadError.new('Account cannot be nil') unless default_options.has_key?(:base_uri)
-    end
-  
+
     def self.find_all(args)
       options = args.extract_options!
-      Hashie::Mash.new(get("#{@@collection_path}", { :query => options }))
+      
+      fetch(collection_path, options)
     end
-  
+
     def self.find_individual(args)
       id = args.shift
       options = args.extract_options!
-      hash = Hashie::Mash.new(response = get("#{@@individual_collection_path}#{id}.xml", { :query => options }))
-      raise HoptoadError.new('SSL should be enabled - use Hoptoad.secure = true in configuration') if response.code == 403
-      hash
+
+      fetch(error_path(id), options)
     end
 
+    def self.collection_path
+      '/errors.xml'
+    end
+
+    def self.error_path(error_id)
+      "/errors/#{error_id}.xml"
+    end
+
   end
-end
+
+  class Notice < Base
+
+    def self.find(id, error_id, options={})
+      setup
+      
+      hash = fetch(find_path(id, error_id), options)
+      
+      if hash.errors
+        raise HoptoadError.new(results.errors.error)
+      end
+      
+      hash.notice
+    end
+    
+    def self.find_all_by_error_id(error_id)
+      setup
+      
+      options = {}
+      notices = []
+      page = 1
+      while true
+        options[:page] = page
+        hash = fetch(all_path(error_id), options)
+        if hash.errors
+          raise HoptoadError.new(results.errors.error)
+        end
+        notice_stubs = hash.notices
+        
+        notice_stubs.map do |notice|
+          notices << find(notice.id, error_id)
+        end
+        break if notice_stubs.size < 30
+        page += 1
+      end
+      notices
+    end
+
+    def self.find_by_error_id(error_id, options={ 'page' => 1})
+      setup
+      
+      hash = fetch(all_path(error_id), options)
+      if hash.errors
+        raise HoptoadError.new(results.errors.error)
+      end
+      
+      hash.notices
+    end
+
+    private
+
+    def self.find_path(id, error_id)
+      "/errors/#{error_id}/notices/#{id}.xml"
+    end
+
+    def self.all_path(error_id)
+      "/errors/#{error_id}/notices.xml"
+    end
+  end
+end
\ No newline at end of file