gemagent 0.0.1.pre → 0.0.2b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gemagent.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Stenhouse
+
+MIT License
+
+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

@@ -1,43 +1,29 @@
-Gemagent
-========
+# Gemagent
 
-By Ryan Stenhouse http://ryanstenhouse.eu 
+TODO: Write a gem description
 
-What is it?
------------
+## Installation
 
-Gemagent is a purely Standard Ruby implementation of a consumer of 
-the FreeAgent Central API.
+Add this line to your application's Gemfile:
 
-The goal of this project was not to build a 'fast' API consumer, but
-instead to build a 'correct' one. All published API features of the
-FreeAgent application are implemented.
+    gem 'gemagent'
 
-If it's fast, it's a bonus!
+And then execute:
 
-Installation
-------------
+    $ bundle
 
-Install via rubygems:
+Or install it yourself as:
 
-    $  gem install gemagent
+    $ gem install gemagent
 
-It requires OpenSSL in order to create the HTTPS connection to the
-FreeAgent API.
+## Usage
 
-Extension
----------
-
-The main purpose of this gem was to allow me to become more familiar 
-with the FreeAgent API and to shake out some cobwebs when it came to
-my knowledge of Ruby's Standard Library.
-
-Because of this, some parts (like local data storage) are sub-optimal.
-
-I have, however, build some abstraction on top of the data storage, 
-HTTP requests and XML parsing to allow for some or all of these
-components to be replaced at a later date. 
-
-See the documentation online for more information.
+TODO: Write usage instructions here
 
+## Contributing
 
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/gemagent.gemspec

@@ -1,25 +1,20 @@
-summary = "GemAgent is a clean and light way to interact with the FreeAgent API. " 
-description = <<-TXT
-  GemAgent lets users of FreeAgent Central's online accounting software
-  to interact with the API simply and cleanly by only using functionality
-  provided by Ruby's Standard Library.
-TXT
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gemagent/version', __FILE__)
 
-Gem::Specification.new do |spec|
-  spec.name = "gemagent"
-  spec.version = '0.0.1.pre'
-  spec.platform = Gem::Platform::RUBY
-  spec.files =  Dir.glob("{bin,lib,.}/**/**/*") +
-                      ["gemagent.rb","README.md","HACKING",'LICENCE','CONTRIBUTORS', "gemagent.gemspec"]
-  spec.require_path = "lib"
-  spec.required_ruby_version = '>= 1.8.4'
-  spec.required_rubygems_version = ">= 1.3.0"
-  spec.test_files = Dir[ "test/*_test.rb" ]
-  spec.has_rdoc = false
-  spec.author = "Ryan Stenhouse"
-  spec.email = "ryan@ryanstenhouse.eu"
-  spec.rubyforge_project = "gemagemt"  
-  spec.homepage = "http://ryanstenhouse.eu"
-  spec.summary = summary
-  spec.description = description
-end
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryan Stenhouse"]
+  gem.email         = ["ryan@ryanstenhouse.eu"]
+  gem.summary     = %q{GemAgent is a clean and light way to interact with the FreeAgent API.}
+  gem.description = %q{Easily consume FreeAgent's OAuth2 API using simple data structures. Designed to be easily embedded into any application}
+  gem.rubyforge_project = "gemagent"
+  gem.homepage      = "http://www.ryanstenhouse.eu/projects/gemagent"
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gemagent"
+  gem.require_paths = ["lib"]
+  gem.version       = Gemagent::VERSION
+  gem.add_dependency "oauth2"
+  gem.add_dependency "jason"
+  gem.add_development_dependency "minitest"
+end

data/lib/gemagent.rb

@@ -0,0 +1,5 @@
+require "gemagent/version"
+
+module Gemagent
+  # Your code goes here...
+end

data/lib/gemagent/version.rb

@@ -0,0 +1,3 @@
+module Gemagent
+  VERSION = "0.0.2b"
+end

metadata

@@ -1,92 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gemagent
-version: !ruby/object:Gem::Version 
-  hash: 961915968
-  prerelease: 6
-  segments: 
-  - 0
-  - 0
-  - 1
-  - pre
-  version: 0.0.1.pre
+version: !ruby/object:Gem::Version
+  version: 0.0.2b
+  prerelease: 5
 platform: ruby
-authors: 
+authors:
 - Ryan Stenhouse
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-29 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
-description: "  GemAgent lets users of FreeAgent Central's online accounting software\n  to interact with the API simply and cleanly by only using functionality\n  provided by Ruby's Standard Library.\n"
-email: ryan@ryanstenhouse.eu
+date: 2012-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: &70220108168200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70220108168200
+- !ruby/object:Gem::Dependency
+  name: jason
+  requirement: &70220108167100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70220108167100
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70220108165840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70220108165840
+description: Easily consume FreeAgent's OAuth2 API using simple data structures. Designed
+  to be easily embedded into any application
+email:
+- ryan@ryanstenhouse.eu
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/api_classes.rb
-- lib/api_handler.rb
-- lib/authentication.rb
-- lib/connection.rb
-- ./CONTRIBUTORS
-- ./example/example.rb
-- ./gemagent.gemspec
-- ./gemagent.rb
-- ./HACKING
-- ./lib/api_classes.rb
-- ./lib/api_handler.rb
-- ./lib/authentication.rb
-- ./lib/connection.rb
-- ./LICENCE
-- ./README.md
-- gemagent.rb
+files:
+- .gitignore
+- Gemfile
+- LICENSE
 - README.md
-- HACKING
-- LICENCE
-- CONTRIBUTORS
+- Rakefile
 - gemagent.gemspec
-has_rdoc: true
-homepage: http://ryanstenhouse.eu
+- lib/gemagent.rb
+- lib/gemagent/version.rb
+- test/test_helper.rb
+homepage: http://www.ryanstenhouse.eu/projects/gemagent
 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 
-      hash: 63
-      segments: 
-      - 1
-      - 8
-      - 4
-      version: 1.8.4
-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 
-      hash: 27
-      segments: 
-      - 1
-      - 3
-      - 0
-      version: 1.3.0
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
-rubyforge_project: gemagemt
-rubygems_version: 1.6.1
+rubyforge_project: gemagent
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: GemAgent is a clean and light way to interact with the FreeAgent API.
-test_files: []
-
+test_files:
+- test/test_helper.rb

data/CONTRIBUTORS

@@ -1 +0,0 @@
-Ryan Stenhouse <ryan@ryanstenhouse.eu>

data/HACKING

@@ -1,8 +0,0 @@
-The process for accepting patches is as follows:
-
-1. Fork the repository
-2. Make your changes (bonus points for feature branches)
-3. Have some tests for your changes
-4. Submit a pull request
-
-Do not change the version number in the GemSpec.

data/LICENCE

@@ -1,19 +0,0 @@
-Copyright (c) 2011 Ryan Stenhouse and CONTRIBUTORS
-
-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/example/example.rb

@@ -1,13 +0,0 @@
-# GemAgent API Interface
-# Ryan Stenhouse, 20 January 2011
-
-# Longhand representation of connecting to the FreeAgent API
-#
-ga = GemAgent::NetHttpConnection.new 'you.freeagentcentral.com', GemAgent::HttpBasicAuthentication.new('username','password')
-ga.verify # => { :user_id => 1, :permission_level => 8, :company_type => UK_LIMITED }
-
-# Sexy sugary version of the above.
-#
-GemAgent::Api.connect 'you.freeagentcentral.com', 'username', 'password' do |api|
-  api.verify # => { :user_id => 1, :permission_level => 8, :company_type => UK_LIMITED }
-end

data/gemagent.rb

@@ -1,8 +0,0 @@
-GEMAGENT_ROOT = File.expand_path(File.dirname(__FILE__))
-require GEMAGENT_ROOT + '/lib/connection.rb'
-require GEMAGENT_ROOT + '/lib/authentication.rb'
-require GEMAGENT_ROOT + '/lib/api_classes.rb'
-require GEMAGENT_ROOT + '/lib/api_handler.rb'
-
-module GemAgent
-end

data/lib/api_classes.rb

@@ -1,36 +0,0 @@
-require "rexml/document"
-
-module GemAgent
-  module Api
-    
-    def self.connect(freeagent_url, username, password, connection = GemAgent::NetHttpConnection, 
-                                                        authenticator = GemAgent::HttpBasicAuthentication, 
-                                                        api_version = GemAgent::ApiHandler)
-      if !block_given?
-        raise "I need to have a block" and return
-      end
-      api = connection.new(freeagent_url, authenticator.new(username, password), api_version)
-      yield api
-    end
-    
-    class ApiBase
-      def method
-        'GET'
-      end
-    
-      def path
-      end
-      
-      def expected_status
-        '200'
-      end
-      
-    end
-  
-    class Verify < ApiBase
-      def path 
-        '/verify'
-      end
-    end  
-  end
-end

data/lib/api_handler.rb

@@ -1,28 +0,0 @@
-require File.dirname(__FILE__) + '/api_classes.rb'
-module GemAgent
-  class ApiHandler
-    
-    def initialize(connection)
-      @connection = connection
-    end
-    
-    def verify
-      verify = GemAgent::Api::Verify.new
-      response = @connection.send_request(verify)
-      unless response.has_error?
-        {
-          :company_type     => response.headers['company-type'],
-          :user_id          => response.headers['user-id'].to_i,
-          :permission_level => response.headers['user-permission-level'].to_i
-        }
-      else
-        {
-          :error          => response.headers[:error],
-          :body           => response.body,
-          :company_type   => 'ERROR'
-        }
-      end
-    end
-    
-  end
-end

data/lib/authentication.rb

@@ -1,23 +0,0 @@
-module GemAgent
-  class ApiAuthentication
-    def authenticate_for(obj)
-    end
-  end
-  
-  class HttpBasicAuthentication < ApiAuthentication
-    
-    def initialize(username, password)
-      @username = username
-      @password = password
-    end
-    
-    def authenticate_for(obj)
-      if obj.respond_to?(:basic_auth)
-        obj.basic_auth @username, @password
-      else
-        raise "Can't do basic authentication with this, I expect a NetHTTP request"
-      end
-    end
-    
-  end
-end

data/lib/connection.rb

@@ -1,116 +0,0 @@
-require 'net/https'
-require 'uri'
-  
-module GemAgent
-  
-  # ConnectionMethod implements the basic interface all child 
-  # classes must implement to allow connection to the FreeAgent
-  # API.
-  #
-  class ConnectionMethod
-    
-    attr_reader :freeagent_url
-    attr_reader :api
-    attr_reader :authenticator
-    
-    @@method_map = {}
-    
-    def initialize(freeagent_url, authenticator, api_handler = GemAgent::ApiHandler)
-      @freeagent_url = freeagent_url
-      @authenticator = authenticator
-      @api = api_handler.new(self)
-    end
-    
-    def send_request(request)
-      raise "Subclasses of ConnectionMethod must implement their own send_request method"
-    end
-    
-    def wrap_response(response)
-      raise "Subclasses of ConnectionMethod must implement their own wrap_response method"
-    end
-    
-    # Proxies all undefined method to the API handler
-    # associated with the connection.
-    #
-    def method_missing(method, *args)
-      unless args.empty?
-        @api.send(method, args)
-      else
-        @api.send(method) 
-      end
-    end
-  end
-  
-  # The ResponseWrapper is used to present a consistant way
-  # for the various API classes to process messages returned
-  # by the API server.
-  #
-  # If you write your own ConnectionMethod subclass, ensure that
-  # your send_request method returns a ResponseWrapper correctly
-  # set with the correct values for headers and body.
-  #
-  class ResponseWrapper 
-    attr_reader :headers, :body
-    def initialize(headers, body)
-      @headers = headers
-      @body = body
-    end
-    
-    def has_error?
-      !headers[:error].nil?
-    end
-  end
-  
-  # NetHttpConnection is the default method to connect to the
-  # FreeAgent API. It uses the Standard  Ruby library net/http
-  # to create an SSL connection to the FreeAgent server specified
-  # by +@freeagent_url+ and authenticates your request with the
-  # ApiAuthentication subclass you pass thorugh as +authenticator+.
-  #
-  # The last last optional value takes a API Handler class, which
-  # defaults to the standard one which ships with this gem.
-  #
-  class NetHttpConnection < ConnectionMethod
-    
-    @@method_map =  {
-                      'GET'     =>  Net::HTTP::Get,
-                      'POST'    =>  Net::HTTP::Post,
-                      'PUT'     =>  Net::HTTP::Put,
-                      'DELETE'  =>  Net::HTTP::Delete
-                    }
-                    
-    # Sends the +request+ to +@freeagent_url+ over HTTPS. The class
-    # instance variable +@@method_map+ maps each HTTP verb required
-    # to the correct class for instantiation.
-    #                
-    def send_request(request)
-      https = Net::HTTP.new(@freeagent_url, Net::HTTP.https_default_port) 
-      https.use_ssl = true
-      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      req = @@method_map[request.method].new(request.path)
-      req['content-type'] = 'application/xml'
-      req['accept'] = 'application/xml'
-      authenticator.authenticate_for req
-      resp = nil
-      https.start do |http|
-        resp = http.request(req)
-      end
-      if resp.code == request.expected_status
-        wrap_response(resp)
-      else
-        ResponseWrapper.new({ :error => resp.code, :status => resp.code }, resp.body)
-      end
-    end
-    
-    # Wraps the response from net/http in a ResponseWrapper object
-    # so the API classes are able to work with it to do their work.
-    #
-    def wrap_response(response)
-      headers = {}
-      response.each_header { |k,v| headers[k] = v }
-      ResponseWrapper.new(headers, response.body)
-    end
-    
-  end
-    
-end