love 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_store
 .bundle/
 .yardoc/
+pkg/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    love (0.0.1)
+    love (0.0.2)
       activesupport
       yajl-ruby
 
@@ -9,7 +9,16 @@ GEM
   remote: http://rubygems.org/
   specs:
     activesupport (3.0.3)
+    diff-lcs (1.1.2)
     rake (0.8.7)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
     yajl-ruby (0.7.8)
 
 PLATFORMS
@@ -19,4 +28,5 @@ DEPENDENCIES
   activesupport
   love!
   rake
+  rspec (~> 2)
   yajl-ruby

data/README.rdoc

@@ -1,7 +1,7 @@
 = Love
 
-This library accesses the Tender REST API. It is my ode and thanks to the many
-improvements Aaron Patterson did on ActiveRecord.
+This library accesses the Tender REST API. It is my ode to and thanks for the tender 
+lovemaking Aaron Patterson is doing on ActiveRecord.
 
 It is currently read-only, and made especially for scripts that import data from 
 Tender to use in your own application. Feel free to fork and add missing API calls.
@@ -16,10 +16,14 @@ I previously used HTTParty to connect to the Tender API, but I ran into two issu
   receive, invalid UTF-8 characters can get into the system, which will break Ruby
   1.9. Love handles character encoding manually, and will replace all the invalid 
   UTF-8 characters by the UTF "unknown character" character.
-* I still had to handle paging manually to get all data. Love will automatically
+* I had to handle paging manually to get all data. Love will automatically
   send multiple requests to get all the pages to iterate over all the available
   objects.
 
+== Installation
+
+Run <tt>gem install love</tt> or add <tt>gem 'love'</tt> to your Gemfile.
+
 == Usage
 
     require 'love'
@@ -31,7 +35,7 @@ I previously used HTTParty to connect to the Tender API, but I ran into two issu
     end
     
     # Also available:
-    tender.each_users { |c| ... }
+    tender.each_user { |c| ... }
     tender.each_queue { |q| ... }
     tender.each_category { |c| ... }
     

data/lib/love.rb

@@ -1,113 +1,141 @@
 require 'uri'
 require 'net/https'
-require 'active_support'
+require 'active_support/core_ext/module/attribute_accessors.rb'
 require 'yajl'
 
-class Love
-  
+module Love
+
   # Create a custom exception class.
   class Exception < StandardError; end
   
   # Class for unauthorized exceptions
   class Unauthorized < Love::Exception; end
   
-  attr_accessor :logger
-  
-  attr_reader :account
-  attr_reader :api_key
-
-  attr_accessor :sleep_between_requests
-
-  def initialize(account, api_key, options = {})
-    @account, @api_key = account, api_key
-    
-    # Handle options
-    @sleep_between_requests = options[:sleep_between_requests] || 0.5
-  end
   
   def self.connect(account, api_key, options = {})
-    new(account, api_key, options)
+    Love::Client.new(account, api_key, options)
   end
+  
+  mattr_accessor :logger
 
-  def get_user(id_or_href, options = {})
-    if id_or_href.to_s =~ /(\d+)$/
-      get("users/#{$1}", options)
-    else 
-      # TODO: use href
-      nil
+  module ResourceURI
+    def collection_uri(input)
+      case input.to_s
+      when /^[\w-]+$/
+        ::URI.parse("https://api.tenderapp.com/#{account}/#{input}")
+      when %r[^https?://api\.tenderapp\.com/#{account}/[\w-]+]
+        ::URI.parse(input.to_s)
+      else
+        raise Love::Exception, "This does not appear to be a valid Tender category URI!"
+      end
     end
-  end
   
-  def get_discussion(id_or_href, options = {})
-    if id_or_href.to_s =~ /(\d+)$/
-      get("discussions/#{$1}", options)
-    else 
-      # TODO: use href
-      nil
+    def singleton_uri(input, kind)
+      case input.to_s
+      when /^\d+/
+        ::URI.parse("https://api.tenderapp.com/#{account}/#{kind}/#{input}")
+      when %r[^https?://api\.tenderapp\.com/#{account}/#{kind}/\d+]
+        ::URI.parse(input.to_s)
+      else
+        raise Love::Exception, "This does not appear to be a Tender #{kind} URI or ID!"
+      end
     end
   end
-  
-  def each_category(options = {}, &block)
-    buffered_each('categories', 'categories', options, &block)
-  end
+    
+  class Client
+    
+    include Love::ResourceURI
 
-  def each_queue(options = {}, &block)
-    buffered_each('queues', 'named_queues', options, &block)
-  end
+    attr_reader :account
+    attr_reader :api_key
+
+    attr_accessor :sleep_between_requests
+
+    def initialize(account, api_key, options = {})
+      @account, @api_key = account, api_key
+    
+      # Handle options
+      @sleep_between_requests = options[:sleep_between_requests] || 0.5
+    end
   
-  def each_user(options = {}, &block)
-    buffered_each('users', 'users', options, &block)
-  end
+    def get_user(id_or_href, options = {})
+      get(singleton_uri(id_or_href, 'users'))
+    end
   
-  def each_discussion(options = {}, &block)
-    buffered_each('discussions', 'discussions', options, &block)
-  end  
+    def get_discussion(id_or_href, options = {})
+      get(singleton_uri(id_or_href, 'discussions'))
+    end
   
-  protected
+    def get_category(id_or_href, options = {})
+      get(singleton_uri(id_or_href, 'categories'))
+    end
   
-  def get(path, options = {})
-    url = URI.parse("https://api.tenderapp.com/#{account}/#{path}")
+    def get_queue(id_or_href, options = {})
+      get(singleton_uri(id_or_href, 'queues'), options)
+    end
+  
+    def each_category(options = {}, &block)
+      buffered_each(collection_uri('categories'), 'categories', options, &block)
+    end
 
-    logger.debug "GET #{url.to_s}" if logger
+    def each_queue(options = {}, &block)
+      buffered_each(collection_uri('queues'), 'named_queues', options, &block)
+    end
+  
+    def each_user(options = {}, &block)
+      buffered_each(collection_uri('users'), 'users', options, &block)
+    end
+  
+    def each_discussion(options = {}, &block)
+      buffered_each(collection_uri('discussions'), 'discussions', options, &block)
+    end
+  
+    protected
+  
+    def get(uri)
+      Love.logger.debug "GET #{url}" if Love.logger
 
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = true
-    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http = Net::HTTP.new(uri.host, uri.port)
+      if uri.scheme = 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
       
-    req = Net::HTTP::Get.new(url.path, {
-      "Accept"        => "application/vnd.tender-v1+json",
-      "X-Tender-Auth" => api_key
-    })
+      req = Net::HTTP::Get.new(uri.request_uri, {
+        "Accept"        => "application/vnd.tender-v1+json",
+        "X-Tender-Auth" => api_key
+      })
 
-    response = http.request(req)
-    case response.code
-    when /2\d\d/
-      converter = Encoding::Converter.new('binary', 'utf-8', :invalid => :replace, :undef => :replace)
-      Yajl::Parser.new.parse(converter.convert(response.body))
-    when '401'
-      raise Love::Unauthorized, "Invalid credentials used!"
-    else
-      raise Love::Exception, "#{response.cody}: #{response.body}"
+      response = http.request(req)
+      case response.code
+      when /^2\d\d/
+        converter = Encoding::Converter.new('binary', 'utf-8', :invalid => :replace, :undef => :replace)
+        Yajl::Parser.new.parse(converter.convert(response.body))
+      when '401'
+        raise Love::Unauthorized, "Invalid credentials used!"
+      else
+        raise Love::Exception, "#{response.code}: #{response.body}"
+      end
     end
-  end
   
-  def buffered_each(path, list_key, options = {}, &block)
-    query_options = {}
-    query_options[:since] = options[:since].to_date.to_s(:db) if options[:since]
+    def buffered_each(uri, list_key, options = {}, &block)
+      query_options = {}
+      query_options[:since] = options[:since].to_date.to_s(:db) if options[:since]
 
-    initial_result = get(path, :query => query_options)
-    start_page = [options[:start_page].to_i, 1].max rescue 1
-    max_page   = (initial_result['total'].to_f / initial_result['per_page'].to_f).ceil
-    end_page   = options[:end_page].nil? ? max_page : [options[:end_page].to_i, max_page].min
-    
-    # Print out some initial debugging information
+      initial_result = get(path, :query => query_options)
+      start_page = [options[:start_page].to_i, 1].max rescue 1
+      max_page   = (initial_result['total'].to_f / initial_result['per_page'].to_f).ceil
+      end_page   = options[:end_page].nil? ? max_page : [options[:end_page].to_i, max_page].min
     
-    logger.debug "Paged requests to #{path}: #{max_page} total pages, importing #{start_page} upto #{end_page}." if logger
+      # Print out some initial debugging information
+      Love.logger.debug "Paged requests to #{path}: #{max_page} total pages, importing #{start_page} upto #{end_page}." if Love.logger
     
-    start_page.upto(end_page) do |page|
-      result = get(path, :query => query_options.merge(:page => page))
-      result[list_key].each { |record| yield(record) }
-      sleep(sleep_between_requests) if sleep_between_requests
+      start_page.upto(end_page) do |page|
+        uri.query = query_options.map { |k, v| "#{k}=#{v}" }.join('&')
+        result = get(uri)
+        result[list_key].each { |record| yield(record) }
+        sleep(sleep_between_requests) if sleep_between_requests
+      end
     end
   end
 end

data/love.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
 
   # Do not change the version and date fields by hand. This will be done
   # automatically by the gem release script.
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.date    = "2010-11-29"
 
   s.summary     = "Ruby library to access the Tender REST API."
@@ -21,13 +21,13 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('yajl-ruby')
 
   s.add_development_dependency('rake')
-  # s.add_development_dependency('rspec', '~> 2.1')
+  s.add_development_dependency('rspec', '~> 2')
 
   s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
   s.extra_rdoc_files = ['README.rdoc']
 
   # Do not change the files and test_files fields by hand. This will be done
   # automatically by the gem release script.
-  s.files      = %w(.gitignore Gemfile Gemfile.lock LICENSE README.rdoc Rakefile lib/love.rb love.gemspec tasks/github-gem.rb)
-  s.test_files = %w()
+  s.files      = %w(.gitignore Gemfile Gemfile.lock LICENSE README.rdoc Rakefile lib/love.rb love.gemspec spec/love_spec.rb spec/spec_helper.rb tasks/github-gem.rb)
+  s.test_files = %w(spec/love_spec.rb)
 end

data/spec/love_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Love::ResourceURI do
+  
+  include Love::ResourceURI
+  def account; "mysupport"; end
+  
+  describe '#collection_uri' do
+
+    it "should build a valid URI based on the resource name" do
+      collection_uri('foos').should be_kind_of(::URI)
+      collection_uri('bars').to_s.should == 'https://api.tenderapp.com/mysupport/bars'
+    end
+    
+    it "should accept a valid URI string" do
+      collection_uri('https://api.tenderapp.com/mysupport/bars').should be_kind_of(::URI)
+      collection_uri('https://api.tenderapp.com/mysupport/bars').to_s.should == 'https://api.tenderapp.com/mysupport/bars'
+    end
+
+    it "should accept a valid URI object" do
+      uri = URI.parse('https://api.tenderapp.com/mysupport/bars')
+      collection_uri(uri).should be_kind_of(::URI)
+      collection_uri(uri).should == uri
+    end
+    
+    it "should not accept a URI for another account" do
+      lambda { collection_uri('https://api.tenderapp.com/other/bars') }.should raise_error(Love::Exception)
+    end
+
+    it "should not accept an unrelated URI" do
+      lambda { collection_uri('http://www.vanbergen.org/mysupport/foos') }.should raise_error(Love::Exception)
+    end
+
+    it "should not weird resource names" do
+      lambda { collection_uri('%!&') }.should raise_error(Love::Exception)
+    end
+  end
+  
+  describe '#singleton_uri' do
+    
+    it "should build a valid URI based on the resource ID" do
+      singleton_uri(123, 'foos').should be_kind_of(::URI)
+      singleton_uri('456', 'bars').to_s.should == 'https://api.tenderapp.com/mysupport/bars/456'
+    end
+    
+    it "should accept a valid URI string" do
+      singleton_uri('https://api.tenderapp.com/mysupport/foos/123', 'foos').should be_kind_of(::URI)
+      singleton_uri('https://api.tenderapp.com/mysupport/bars/456', 'bars').to_s.should == 'https://api.tenderapp.com/mysupport/bars/456'
+    end
+
+    it "should accept a valid URI object" do
+      uri = URI.parse('https://api.tenderapp.com/mysupport/bars/789')
+      singleton_uri(uri, 'bars').should be_kind_of(::URI)
+      singleton_uri(uri, 'bars').should == uri
+    end    
+    
+    it "should not accept a URI for another account" do
+      lambda { singleton_uri('https://api.tenderapp.com/other/bars/123', 'bars') }.should raise_error(Love::Exception)
+    end
+
+    it "should not accept an unrelated URI" do
+      lambda { singleton_uri('http://www.vanbergen.org/mysupport/foos', 'foos') }.should raise_error(Love::Exception)
+    end
+
+    it "should not weird resource IDs" do
+      lambda { singleton_uri('%!&', 'bars') }.should raise_error(Love::Exception)
+    end    
+  end
+end
+
+describe Love::Client do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :development)
+
+RSpec.configure do |config|
+  # nothing here
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: love
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -18,44 +19,61 @@ date: 2010-11-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  name: activesupport
   prerelease: false
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: yajl-ruby
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  name: yajl-ruby
   prerelease: false
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: *id004
 description: "    A simple API wrapper for Tender, that handles paged results, uses yajl-ruby for\n    JSON parsing, and manually handles UTF-8 encoding to circumvent the invalid UTF-8\n    character problem in Ruby 1.9.\n"
 email: 
 - willem@railsdoctors.com
@@ -74,6 +92,8 @@ files:
 - Rakefile
 - lib/love.rb
 - love.gemspec
+- spec/love_spec.rb
+- spec/spec_helper.rb
 - tasks/github-gem.rb
 has_rdoc: true
 homepage: http://github.com/wvanbergen/love
@@ -94,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1414303505794391607
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -103,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1414303505794391607
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -114,5 +134,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby library to access the Tender REST API.
-test_files: []
-
+test_files: 
+- spec/love_spec.rb