letsfreckle-client 0.1.2 → 0.2.0

data/bin/run-examples

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'letsfreckle'
+
+# Configure the API credentials.
+LetsFreckle.configure do
+  account_host "apitest"
+  username "apitest@letsfreckle.com"
+  token "lx3gi6pxdjtjn57afp8c2bv1me7g89j"
+end
+
+puts "Fetch all entries:"
+LetsFreckle::Entry.all.each do |entry|
+  puts "Entry #{entry.description} - #{entry.minutes} minutes"
+end
+
+puts "Search for entries from a specific start date and tags:"
+LetsFreckle::Entry.find(:from => '2010-07-10', :tags => ['development', 'design']).each do |entry|
+  puts entry.description
+end
+
+puts "Fetch all projects and associated entries:"
+LetsFreckle::Project.all.each do |project|
+  puts "Project #{project.name} has #{project.entries.size} entries"
+end
+
+puts "Fetch all tags and associated entries:"
+LetsFreckle::Tag.all.each do |tag|
+  puts "Tag #{tag.name} has #{tag.entries.size} entries"
+end
+
+puts "Fetch all users and associated permissions:"
+LetsFreckle::User.all.each do |user|
+  puts "User #{user.email} has following permissions: #{user.permissions}"
+end
+
+
+
+
+

data/letsfreckle-client.gemspec

@@ -19,8 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency("httparty", ">= 0.7.8")
-  s.add_dependency("hashie", ">= 1.0.0")
-  s.add_development_dependency("rspec", "~> 2.5.0")
-  s.add_development_dependency("webmock", "~> 1.6.2")
+  s.add_dependency 'hashie', '~> 1.1.0'
+  s.add_dependency 'faraday', '~> 0.7.4'
+  s.add_dependency 'faraday_middleware', '~> 0.7.0'
+  s.add_dependency 'multi_xml', '~> 0.2.0'
+  s.add_development_dependency "activesupport", "~> 2.3"
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+  s.add_development_dependency 'webmock', '~> 1.6.2'
 end

data/lib/faraday/request/xml.rb

@@ -0,0 +1,20 @@
+module Faraday
+  class Request
+    class XML < Faraday::Middleware
+      dependency 'active_support/all'
+
+      def initialize(app, options={})
+        @app     = app
+        @options = options
+      end
+
+      def call(env)
+        if env[:method] == :post
+          env[:body] = env[:body].to_xml(:root => env[:body].delete(:root))
+          puts env[:body]
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/faraday/response/flatten_body.rb

@@ -0,0 +1,19 @@
+module Faraday
+  class Response
+    # FlattenBody is a middleware that flattens the response body, and also extends
+    # Hashie::Mash instances with a module that allows them to work properly with DelegateClass.
+    class FlattenBody < Response::Middleware
+      dependency 'hashie/mash'
+
+      def parse(body)
+        return body unless body.respond_to?(:to_a)
+        flattened_response = body.to_a.flatten
+        flattened_response.keep_if { |item| ::Hashie::Mash === item }
+        flattened_response.map do |mash|
+          # extend so that #respond_to? works nicely with DelegateClass
+          mash.extend(LetsFreckle::Extensions::Mash)
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/verify_status.rb

@@ -0,0 +1,17 @@
+module Faraday
+  class Response
+    class VerifyStatus < Response::Middleware
+      def on_complete(env)
+        status = env[:status].to_i
+        case env[:method]
+        when :get
+          raise LetsFreckle::FetchError, "Fetch failed, HTTP error: #{status}" unless status == 200
+        when :post
+          raise LetsFreckle::CreateError, "Create failed, HTTP error: #{status}" unless status == 201
+        end
+      end
+    end
+  end
+end
+
+

data/lib/letsfreckle.rb

@@ -1,7 +1,12 @@
-require 'hashie'
-require 'httparty'
 require 'delegate'
 
+require 'hashie'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/request/xml'
+require 'faraday/response/flatten_body'
+require 'faraday/response/verify_status'
+
 require 'letsfreckle/version'
 require 'letsfreckle/extensions/mash'
 require 'letsfreckle/configuration'

data/lib/letsfreckle/client_resource.rb

@@ -2,38 +2,41 @@ module LetsFreckle
   # ClientResource should be extended by resource classes in order to gain
   # access to HTTP methods.
   module ClientResource
-    API_URL = "https://%s.letsfreckle.com/api/%s.xml?token=%s"
 
-    def fetch(resource, options = {})
-      response = HTTParty.get(url(resource), :query => options, :format => :xml)
-      verify!(response, 200) { raise FetchError, "Fetch failed, HTTP error: #{response.code}" }
-      mashes = mashes_from_response(response)
-      mashes.map { |m| new(m) }
+    def get(resource, options = {})
+      response = client.get do |request|
+        request.url relative_path_for(resource), options
+      end
+      response.body.map { |mash| new(mash) }
     end
 
     def post(resource, options = {})
-      response = HTTParty.post(url(resource), :body => options, :format => :xml)
-      verify!(response, 201) { raise CreateError, "Create failed, HTTP error: #{response.code}" }
+      client.post do |request|
+        request.url relative_path_for(resource)
+        request.headers['Content-Type'] = 'application/xml'
+        request.body = options
+      end
     end
 
-    def url(resource)
-      API_URL % [LetsFreckle.config.account_host, resource, LetsFreckle.config.token]
+    def base_api_url
+      "https://#{LetsFreckle.config.account_host}.letsfreckle.com"
     end
 
-    private
-
-    def verify!(response, code, &block)
-      block.call unless response.code == code
+    def relative_path_for(resource)
+      "/api/#{resource}.xml?token=#{LetsFreckle.config.token}"
     end
 
-    def mashes_from_response(response)
-      return [] unless response.respond_to?(:to_a)
-      flattened_response = response.to_a.flatten
-      flattened_response.keep_if { |r| r.is_a?(Hash) }
-      flattened_response.map do |h|
-        m = Hashie::Mash.new(h)
-        # extend so that #respond_to? works nicely with DelegateClass
-        m.extend(Extensions::Mash)
+    private
+
+    def client
+      Faraday.new(:url => base_api_url) do |builder|
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Request::XML
+        builder.use Faraday::Response::FlattenBody
+        builder.use Faraday::Response::Mashify
+        builder.use Faraday::Response::ParseXml
+        builder.use Faraday::Response::VerifyStatus
+        builder.use Faraday::Adapter::NetHttp
       end
     end
   end

data/lib/letsfreckle/entry.rb

@@ -3,7 +3,7 @@ module LetsFreckle
     extend ClientResource
 
     def self.all
-      fetch('entries')
+      get('entries')
     end
 
     # Fetches all entries. Supported options are:
@@ -14,7 +14,7 @@ module LetsFreckle
     #  :to => '2012-01-01'
     #  :billable => true/false
     def self.find(options = {})
-      fetch('entries', searchable_options_from(options))
+      get('entries', searchable_options_from(options))
     end
 
     # Creates a new entry. Supported options are:
@@ -25,14 +25,16 @@ module LetsFreckle
     def self.create(options = {})
       raise ArgumentError, ':username config missing' unless LetsFreckle.config.username
       raise ArgumentError, ':minutes missing' unless options.has_key?(:minutes)
-      post('entries', :entry => options.merge(:user => LetsFreckle.config.username))
+      post('entries', options.merge(:root => :entry, :user => LetsFreckle.config.username))
     end
 
     def self.searchable_options_from(options = {})
       options.each_with_object({}) do |(key, value), result|
         case value
-        when Array then result["search[#{key}]"] = value.join(',')
-        else result["search[#{key}]"] = value.to_s
+        when Array then
+          result["search[#{key}]"] = value.join(',')
+        else
+          result["search[#{key}]"] = value.to_s
         end
       end
     end

data/lib/letsfreckle/error.rb

@@ -1,6 +1,5 @@
 module LetsFreckle
-  class FetchError < StandardError
-  end
-  class CreateError < StandardError
-  end
-end
+  class Error < StandardError; end
+  class FetchError < Error; end
+  class CreateError < Error; end
+end

data/lib/letsfreckle/project.rb

@@ -3,7 +3,7 @@ module LetsFreckle
     extend ClientResource
 
     def self.all
-      fetch('projects')
+      get('projects')
     end
 
     def entries

data/lib/letsfreckle/tag.rb

@@ -3,7 +3,7 @@ module LetsFreckle
     extend ClientResource
 
     def self.all
-      fetch('tags')
+      get('tags')
     end
 
     def entries

data/lib/letsfreckle/user.rb

@@ -3,7 +3,7 @@ module LetsFreckle
     extend ClientResource
 
     def self.all
-      fetch('users')
+      get('users')
     end
 
     def entries

data/lib/letsfreckle/version.rb

@@ -1,3 +1,3 @@
 module Letsfreckle
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/letsfreckle/entry_spec.rb

@@ -9,7 +9,7 @@ describe LetsFreckle::Entry do
         token "secret"
       end
 
-      stub_http_request(:get, LetsFreckle::Entry.url('entries')).to_return(:body => load_response('entries'))
+      stub_api_request('entries')
       entries = LetsFreckle::Entry.all
       entries.size.should == 2
 

data/spec/letsfreckle/project_spec.rb

@@ -9,7 +9,7 @@ describe LetsFreckle::Project do
         token "secret"
       end
 
-      stub_http_request(:get, LetsFreckle::Project.url('projects')).to_return(:body => load_response('projects'))
+      stub_api_request('projects')
       projects = LetsFreckle::Project.all
       projects.size.should == 2
 

data/spec/letsfreckle/tag_spec.rb

@@ -9,7 +9,7 @@ describe LetsFreckle::Tag do
         token "secret"
       end
 
-      stub_http_request(:get, LetsFreckle::Tag.url('tags')).to_return(:body => load_response('tags'))
+      stub_api_request('tags')
       tags = LetsFreckle::Tag.all
       tags.size.should == 2
 

data/spec/letsfreckle/user_spec.rb

@@ -9,7 +9,7 @@ describe LetsFreckle::User do
         token "secret"
       end
 
-      stub_http_request(:get, LetsFreckle::User.url('users')).to_return(:body => load_response('users'))
+      stub_api_request('users')
       users = LetsFreckle::User.all
       users.size.should == 2
 

data/spec/support/webmock_helper.rb

@@ -2,4 +2,16 @@ module WebMockHelper
   def load_response(resource)
     File.read(File.join(File.dirname(__FILE__), '/../responses', "#{resource}.xml.response"))
   end
-end
+
+  def url_for_resource(resource)
+    "#{LetsFreckle::Entry.base_api_url}#{LetsFreckle::Entry.relative_path_for(resource)}"
+  end
+
+  def stub_api_request(resource)
+    stub_http_request(:get, url_for_resource(resource)).
+        with(:headers => { 'Accept'         =>'*/*',
+                           'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                           'User-Agent'     =>'Ruby' }).
+        to_return(:body => load_response(resource))
+  end
+end

metadata

@@ -1,98 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: letsfreckle-client
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ryan LeCompte
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-25 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: httparty
+date: 2011-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70346356154000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *70346356154000
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70346356153180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        - 8
-        version: 0.7.8
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70346356153180
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70346356152680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70346356152680
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &70346356152220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 5
-        - 0
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70346356152220
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70346356151760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70346356151760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70346356151260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70346356151260
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70346356150740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.6.2
   type: :development
-  version_requirements: *id004
-description: Ruby client for letsfreckle.com API that supports entries, projects, tags, and users
-email: 
+  prerelease: false
+  version_requirements: *70346356150740
+description: Ruby client for letsfreckle.com API that supports entries, projects,
+  tags, and users
+email:
 - lecompte@gmail.com
-executables: []
-
+executables:
+- run-examples
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
+- bin/run-examples
 - letsfreckle-client.gemspec
+- lib/faraday/request/xml.rb
+- lib/faraday/response/flatten_body.rb
+- lib/faraday/response/verify_status.rb
 - lib/letsfreckle.rb
 - lib/letsfreckle/client_resource.rb
 - lib/letsfreckle/configuration.rb
@@ -114,39 +128,31 @@ files:
 - spec/responses/users.xml.response
 - spec/spec_helper.rb
 - spec/support/webmock_helper.rb
-has_rdoc: true
 homepage: http://github.com/ryanlecompte/letsfreckle-client
 licenses: []
-
 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 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: letsfreckle-client
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6.1
 signing_key: 
 specification_version: 3
 summary: Ruby client for letsfreckle.com API
-test_files: 
+test_files:
 - spec/letsfreckle/configuration_spec.rb
 - spec/letsfreckle/entry_spec.rb
 - spec/letsfreckle/project_spec.rb