horde_rpc 0.2.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.*.swp
+.*.swo
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  # - rbx-19mode
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# develop
+
+# v0.2.0
+  * Rename to HordeRPC
+
+# v0.1.0
+  * First release!

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 Mojo Lingo LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+horde_rpc
+===========
+
+horde_rpc is a client library for accessing the Horde XML-RPC interface from Ruby.
+
+Features
+--------
+
+* Retrieve Client records
+* Record time for Clients
+
+Requirements
+------------
+
+* A working Horde installation
+
+Install
+-------
+
+    gem install horde_rpc
+
+Examples
+--------
+
+```ruby
+  require 'horde_rpc'
+  horde = HordeRPC.new 'http://horde.bar.com'
+  client = horde.first_client_for_company 'UberClient'
+  puts "Client by name 'UberClient' has ID #{client['id']}"
+
+  horde.record_time :client       => client['id'],
+                    :date         => Date.today,
+                    :hours        => 3.5,
+                    :employee     => 'foo@bar.com',
+                    :description  => 'Did stuff'
+                    :type         => 1
+```
+
+Author
+------
+
+Original author: Ben Langfeld
+
+Links
+-----
+* [Source](https://github.com/mojolingo/horde_rpc)
+* [Documentation](http://rdoc.info/github/mojolingo/horde_rpc/master/frames)
+* [Bug Tracker](https://github.com/mojolingo/horde_rpc/issues)
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2012 Mojo Lingo LLC. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+task :default => :spec
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/horde.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "horde_rpc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "horde_rpc"
+  s.version     = HordeRPC::VERSION
+  s.authors     = ["Ben Langfeld"]
+  s.email       = ["ben@langfeld.me"]
+  s.homepage    = "http://github.com/mojolingo/horde_rpc"
+  s.summary     = %q{A Horde XML-RPC client library in Ruby}
+  s.description = %q{horde_rpc is a client library for accessing the Horde XML-RPC interface from Ruby.}
+
+  s.rubyforge_project = "horde_rpc"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'bundler', ["~> 1.0"]
+  s.add_development_dependency 'rspec', ["~> 2.8"]
+  s.add_development_dependency 'yard', ["~> 0.6"]
+  s.add_development_dependency 'rake', [">= 0"]
+  s.add_development_dependency 'fakeweb', [">= 0"]
+  s.add_development_dependency 'mocha', [">= 0"]
+  s.add_development_dependency 'guard-rspec'
+end

data/lib/horde_rpc.rb

@@ -0,0 +1,104 @@
+require 'horde_rpc/version'
+require 'xmlrpc/client'
+
+class HordeRPC
+  ##
+  # Create a new instance of the Horde connection
+  #
+  # @param [String] uri XML-RPC URI for the horde instance
+  # @param [String, Optional] username
+  # @param [String, Optional] password
+  #
+  def initialize(uri, username = nil, password = nil)
+    @xmlrpc_client = XMLRPC::Client.new2 uri
+    @xmlrpc_client.user     = username
+    @xmlrpc_client.password = password
+  end
+
+  ##
+  # Make an RPC request against the Horde instance
+  #
+  # @param [String] method the method name to execute
+  # @param [Object, Optional] options
+  #
+  # @return [Object] response to the RPC
+  #
+  def request(method, *options)
+    @xmlrpc_client.call method, *options
+  end
+
+  ##
+  # Return data for a client by its ID
+  #
+  # @param [String] id the clients ID
+  #
+  # @return [Hash,nil] client data
+  #
+  def get_client_by_id(id)
+    request 'clients.getClient', id
+  end
+
+  ##
+  # Search clients by KV-pairs
+  #
+  # @param [Hash<#to_s, String>] search_params
+  #
+  # @return [Hash] map of search terms to results
+  #
+  # @example Search for clients by first name
+  #
+  #   horde.search_clients :firstname => 'Bob'
+  #   # => {'Acme' => [
+  #          {
+  #           "__key"       => "uid=foo@bar.com",
+  #           "__uid"       => "foo@bar.com",
+  #           "firstname"   => "Joe",
+  #           "lastname"    => "Bloggs",
+  #           "name"        => "Joe Bloggs",
+  #           "email"       => "foo@bar.com",
+  #           "homePhone"   => "404 475 4840",
+  #           "workPhone"   => "404 475 4840",
+  #           "cellPhone"   => "404 475 4840",
+  #           "homeAddress" => "Foo Lane, NY",
+  #           "company"     => "Acme",
+  #           "id"          => "uid=foo@bar.com",
+  #           "__type"      => "Object",
+  #           "source"      => "bar_clients"
+  #          }]
+  #        }
+  #
+  def search_clients(search_params = {})
+    # searchClients takes two arrays as params:
+    # * list of search strings
+    # * list of search fields
+    request 'clients.searchClients', search_params.values, search_params.keys.map(&:to_s)
+  end
+
+  ##
+  # Find the first client record for a particular company name
+  #
+  # @param [String] name the name of the Company
+  #
+  # @return [Hash,nil] data for the client associated with the requested company
+  #
+  def first_client_for_company(name)
+    results = search_clients :company => name
+    results[name].first
+  end
+
+  ##
+  # Record time against a project
+  #
+  # @params [Hash] options
+  # @option options [Date] :date the date of the billable activity
+  # @option options [String] :client the ID of the client to bill
+  # @option options [Integer] :type the type of billable activity
+  # @option options [Float] :hours the number of hours to bill
+  # @option options [String] :description a description of the billable activity
+  # @option options [String] :employee the username of the employee performing the billable activity
+  #
+  def record_time(options)
+    raise ArgumentError unless options.values_at(:date, :client, :type, :hours, :description, :employee).all?
+    request 'time.recordTime', options
+  end
+end

data/lib/horde_rpc/version.rb

@@ -0,0 +1,3 @@
+class HordeRPC
+  VERSION = "0.2.0"
+end

data/spec/horde_rpc_spec.rb

@@ -0,0 +1,280 @@
+require 'spec_helper'
+
+describe HordeRPC do
+  describe "sending requests" do
+    before do
+      FakeWeb.clean_registry
+    end
+
+    it "should hit the specified domain/port" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      FakeWeb.register_uri :post, "http://horde.bar.com/rpc/",
+                           :status => ["200", "OK"],
+                           :content_type => "text/xml",
+                           :body => <<-RESPONSE
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value><string>bar</string></value>
+    </param>
+  </params>
+</methodResponse>
+RESPONSE
+
+      horde.request 'foo'
+    end
+
+    it "should be formatted as XMLRPC" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      FakeWeb.register_uri :post, "http://horde.bar.com/rpc/",
+                           :status => ["200", "OK"],
+                           :content_type => "text/xml",
+                           :body => <<-RESPONSE
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value><string>bar</string></value>
+    </param>
+  </params>
+</methodResponse>
+RESPONSE
+
+      horde.request 'foo'
+
+      FakeWeb.last_request.body.should match(/<methodCall>/)
+    end
+
+    it "should invoke the correct method, with the correct parameters, including user/password options" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/', 'usera', 'passwordb'
+
+      FakeWeb.register_uri :post, "http://usera:passwordb@horde.bar.com/rpc/",
+                           :status => ["200", "OK"],
+                           :content_type => "text/xml",
+                           :body => <<-RESPONSE
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value><string>bar</string></value>
+    </param>
+  </params>
+</methodResponse>
+RESPONSE
+
+      horde.request 'foo', :foo => 'bar'
+
+      FakeWeb.last_request.body.should be == "<?xml version=\"1.0\" ?><methodCall><methodName>foo</methodName><params><param><value><struct><member><name>foo</name><value><string>bar</string></value></member></struct></value></param></params></methodCall>\n"
+    end
+
+    it "should be able to make a request without options" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      FakeWeb.register_uri :post, "http://horde.bar.com/rpc/",
+                           :status => ["200", "OK"],
+                           :content_type => "text/xml",
+                           :body => <<-RESPONSE
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value><string>bar</string></value>
+    </param>
+  </params>
+</methodResponse>
+RESPONSE
+
+      horde.request 'foo'
+
+      FakeWeb.last_request.body.should be == "<?xml version=\"1.0\" ?><methodCall><methodName>foo</methodName><params/></methodCall>\n"
+    end
+
+    it "should be able to make a request with multiple options" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      FakeWeb.register_uri :post, "http://horde.bar.com/rpc/",
+                           :status => ["200", "OK"],
+                           :content_type => "text/xml",
+                           :body => <<-RESPONSE
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value><string>bar</string></value>
+    </param>
+  </params>
+</methodResponse>
+RESPONSE
+
+      horde.request 'foo', 'bar', 'baz'
+
+      FakeWeb.last_request.body.should be == "<?xml version=\"1.0\" ?><methodCall><methodName>foo</methodName><params><param><value><string>bar</string></value></param><param><value><string>baz</string></value></param></params></methodCall>\n"
+    end
+
+    it "should return the returned data structure" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      FakeWeb.register_uri :post, "http://horde.bar.com/rpc/",
+                           :status => ["200", "OK"],
+                           :content_type => "text/xml",
+                           :body => <<-RESPONSE
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value><string>bar</string></value>
+    </param>
+  </params>
+</methodResponse>
+RESPONSE
+
+      horde.request('foo').should be == 'bar'
+    end
+  end
+
+  describe "fetching a client by ID" do
+    it "should return the fetched client data" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      id = "uid=foo@bar.com"
+
+      response = {
+        "__key"       => "uid=foo@bar.com",
+        "__uid"       => "foo@bar.com",
+        "firstname"   => "Joe",
+        "lastname"    => "Bloggs",
+        "name"        => "Joe Bloggs",
+        "email"       => "foo@bar.com",
+        "homePhone"   => "404 475 4840",
+        "workPhone"   => "404 475 4840",
+        "cellPhone"   => "404 475 4840",
+        "homeAddress" => "Foo Lane, NY",
+        "company"     => "Acme",
+        "id"          => "uid=foo@bar.com",
+        "__type"      => "Object",
+        "source"      => "bar_clients"
+      }
+
+      horde.expects(:request).once.with('clients.getClient', id).returns response
+
+      client = horde.get_client_by_id id
+      client.should be response
+    end
+  end
+
+  describe "searching for clients" do
+    it "should return a set of client data" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      response = {'Acme' => [
+        {
+          "__key"       => "uid=foo@bar.com",
+          "__uid"       => "foo@bar.com",
+          "firstname"   => "Joe",
+          "lastname"    => "Bloggs",
+          "name"        => "Joe Bloggs",
+          "email"       => "foo@bar.com",
+          "homePhone"   => "404 475 4840",
+          "workPhone"   => "404 475 4840",
+          "cellPhone"   => "404 475 4840",
+          "homeAddress" => "Foo Lane, NY",
+          "company"     => "Acme",
+          "id"          => "uid=foo@bar.com",
+          "__type"      => "Object",
+          "source"      => "bar_clients"
+        }]
+      }
+
+      horde.expects(:request).once.with('clients.searchClients', ['Acme'], ['company']).returns response
+
+      client = horde.search_clients :company => 'Acme'
+      client.should be response
+    end
+  end
+
+  describe "finding the first client by company name" do
+    it "should return the relevant client data" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      client_data = {
+        "__key"       => "uid=foo@bar.com",
+        "__uid"       => "foo@bar.com",
+        "firstname"   => "Joe",
+        "lastname"    => "Bloggs",
+        "name"        => "Joe Bloggs",
+        "email"       => "foo@bar.com",
+        "homePhone"   => "404 475 4840",
+        "workPhone"   => "404 475 4840",
+        "cellPhone"   => "404 475 4840",
+        "homeAddress" => "Foo Lane, NY",
+        "company"     => "Acme",
+        "id"          => "uid=foo@bar.com",
+        "__type"      => "Object",
+        "source"      => "bar_clients"
+      }
+      response = {'Acme' => [client_data]}
+
+      horde.expects(:request).once.with('clients.searchClients', ['Acme'], ['company']).returns response
+
+      client = horde.first_client_for_company 'Acme'
+      client.should be == client_data
+    end
+
+    context "if no matches are found" do
+      it "should return nil" do
+        horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+        response = {'Acme' => []}
+
+        horde.expects(:request).once.with('clients.searchClients', ['Acme'], ['company']).returns response
+
+        client = horde.first_client_for_company 'Acme'
+        client.should be nil
+      end
+    end
+  end
+
+  describe "recording time" do
+    it "should record time given the requested parameters" do
+      horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+      options = {
+        :date         => Date.today,
+        :client       => 'bob@acme.com',
+        :type         => 1,
+        :hours        => 1.2,
+        :description  => 'Did stuff',
+        :employee     => 'foo@bar.com'
+      }
+
+      horde.expects(:request).once.with('time.recordTime', options)
+
+      horde.record_time options
+    end
+
+    %w{date client type hours description employee}.each do |required_option|
+      context "without specifying #{required_option}" do
+        it "should raise ArgumentError" do
+          horde = HordeRPC.new 'http://horde.bar.com/rpc/'
+
+          options = {
+            :date         => Date.today,
+            :client       => 'bob@acme.com',
+            :type         => 1,
+            :hours        => 1.2,
+            :description  => 'Did stuff',
+            :employee     => 'foo@bar.com'
+          }
+          options.merge! required_option.to_sym => nil
+
+          horde.expects(:request).never
+
+          lambda { horde.record_time options }.should raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'horde_rpc'
+require 'mocha'
+require 'fakeweb'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+FakeWeb.allow_net_connect = false

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: horde_rpc
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Langfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: horde_rpc is a client library for accessing the Horde XML-RPC interface
+  from Ruby.
+email:
+- ben@langfeld.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- horde.gemspec
+- lib/horde_rpc.rb
+- lib/horde_rpc/version.rb
+- spec/horde_rpc_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mojolingo/horde_rpc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4324098499712079725
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4324098499712079725
+requirements: []
+rubyforge_project: horde_rpc
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A Horde XML-RPC client library in Ruby
+test_files:
+- spec/horde_rpc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: