hoptoad-api 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+*.gem
+pkg/*

data/README.textile

@@ -0,0 +1,30 @@
+h1. Hoptoad API
+
+An unofficial Ruby library for interacting with the "Hoptoad API":http://hoptoadapp.com/pages/api
+
+h2. Usage
+
+<pre>
+<code>
+Hoptoad.account = 'myaccount'
+Hoptoad.token = 'abcdeghijklmnopqrstuvwxyz'
+
+# find an individual error:
+Hoptoad::Error.find(12345)
+
+# or get a list of errors using:
+Hoptoad::Error.find(:all)
+Hoptoad::Error.find(:all, :params => { :page => 2 })
+</code>
+</pre>
+
+
+h2. Requirements
+
+* ActiveResource 
+* ActiveSupport
+
+h2. Acknowledgements
+
+* "Hoptoad":http://hoptoadapp.com
+* "Lighthouse-api":http://github.com/Caged/lighthouse-api (inspiration for much of this code)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "hoptoad-api"
+    s.summary = %Q{An unofficial gem for interacting with the Hoptoad API}
+    s.email = "steve.agalloco@gmail.com"
+    s.homepage = "http://github.com/spagalloco/hoptoad-api"
+    s.description = "An unofficial gem for interacting with the Hoptoad API"
+    s.authors = ["Steve Agalloco"]
+    s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+    s.add_dependency(%q<activeresource>, [">= 2.1.0"])
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/hoptoad-api.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hoptoad-api}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Agalloco"]
+  s.date = %q{2010-04-24}
+  s.description = %q{An unofficial gem for interacting with the Hoptoad API}
+  s.email = %q{steve.agalloco@gmail.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "hoptoad-api.gemspec",
+     "lib/hoptoad-api.rb",
+     "test/hoptoad-api.rb"
+  ]
+  s.homepage = %q{http://github.com/spagalloco/hoptoad-api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An unofficial gem for interacting with the Hoptoad API}
+  s.test_files = [
+    "test/hoptoad-api.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_runtime_dependency(%q<activeresource>, [">= 2.1.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_dependency(%q<activeresource>, [">= 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+    s.add_dependency(%q<activeresource>, [">= 2.1.0"])
+  end
+end
+

data/lib/hoptoad-api.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+
+begin
+  require 'uri'
+  require 'addressable/uri'
+
+  module URI
+    def decode(*args)
+      Addressable::URI.decode(*args)
+    end
+
+    def escape(*args)
+      Addressable::URI.escape(*args)
+    end
+
+    def parse(*args)
+      Addressable::URI.parse(*args)
+    end
+  end
+rescue LoadError
+  puts "Install the Addressable gem to support accounts with subdomains."
+  puts "# sudo gem install addressable"
+  puts
+end
+
+require 'activesupport'
+require 'activeresource'
+
+# 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'
+#
+# If no token or authentication info is given, a HoptoadError exception will be raised.
+#
+# For more details, check out the hoptoad docs at http://hoptoadapp.com/pages/api.
+#
+module Hoptoad
+  class HoptoadError < StandardError; end
+  class << self
+    attr_accessor :host_format, :domain_format, :protocol, :port
+    attr_reader :account, :token
+
+    # Sets the account name, and updates all the resources with the new domain.
+    def account=(name)
+      resources.each do |klass|
+        klass.site = klass.site_format % (host_format % [protocol, domain_format % name, ":#{port}"])
+      end
+      @account = name
+    end
+
+    # Sets the API token for all the resources.
+    def token=(value)
+      @token = value
+    end
+
+    def resources
+      @resources ||= []
+    end
+  end
+
+  self.host_format   = '%s://%s%s'
+  self.domain_format = '%s.hoptoadapp.com'
+  self.protocol      = 'http'
+  self.port          = ''
+
+  class Base < ActiveResource::Base
+    def self.inherited(base)
+      Hoptoad.resources << base
+      class << base
+        attr_accessor :site_format
+
+        def append_auth_token_to_params(*arguments)
+          opts = arguments.last.is_a?(Hash) ? arguments.pop : {}
+          opts = opts.has_key?(:params) ? opts : opts.merge(:params => {})
+          opts[:params] = opts[:params].merge(:auth_token => Hoptoad.token)
+          arguments << opts
+          arguments
+        end
+      end
+      base.site_format = '%s'
+      super
+    end
+  end
+
+  # Find errors
+  #
+  #   Errors are paginated. You get 25 at a time.
+  #   Hoptoad::Error.find(:all)
+  #   Hoptoad::Error.find(:all, :params => { :page => 2 })
+  #
+  #   find individual error by ID
+  #   Hoptoad::Error.find(44) 
+  #
+  class Error < Base
+
+    # find using token
+    def self.find(*arguments)
+      raise HoptoadError.new('API Token cannot be nil') if Hoptoad.token.blank?
+      raise HoptoadError.new('Account cannot be nil') if Hoptoad.account.blank?
+
+      arguments = append_auth_token_to_params(*arguments)
+      super(*arguments)
+    end
+
+    # produces the url on hoptoad's site
+    def url
+      path = Error.site.to_s
+      path << collection_path.gsub!(/^\//,'')
+      path.gsub!('.xml','')
+      path << '/'
+      path << self.id.to_s
+    end
+
+  end
+
+end

data/test/hoptoad-api.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require File.join(File.dirname(__FILE__), "..", "lib", "hoptoad-api")
+
+class HoptoadTest < Test::Unit::TestCase
+
+  context "given a Hoptoad account & API key" do
+    setup do
+      credentials_path = File.join(ENV['HOME'], ".hoptoad.yml")
+      credentials = YAML::load_file(credentials_path)
+      Hoptoad.account = credentials['account']
+      Hoptoad.token   = credentials['token']
+    end
+
+    should "find a page of the 30 most recent errors" do
+      errors  = Hoptoad::Error.find(:all)
+      ordered = errors.sort_by(&:most_recent_notice_at).reverse
+      assert_equal ordered, errors
+      assert_equal 30, errors.size
+    end
+
+    should "have correct collection path" do
+      assert_equal "/errors.xml", Hoptoad::Error.collection_path
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: hoptoad-api
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Steve Agalloco
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: An unofficial gem for interacting with the Hoptoad API
+email: steve.agalloco@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- README.textile
+- Rakefile
+- VERSION.yml
+- hoptoad-api.gemspec
+- lib/hoptoad-api.rb
+- test/hoptoad-api.rb
+has_rdoc: true
+homepage: http://github.com/spagalloco/hoptoad-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An unofficial gem for interacting with the Hoptoad API
+test_files: 
+- test/hoptoad-api.rb