simpletax 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3d20b5583d0667d6db5379323b4576c33d6183e
+  data.tar.gz: a483a20220469e8fee49248725dfd39aa91ad080
+SHA512:
+  metadata.gz: 8ed09d3356b30257dab94392fe0fed0c1420cfc086a9d0db0479340c8bd2962a0cf2448ba4340e5cd913c5ba894239952086852a68a06d4cc3b65c769b62972f
+  data.tar.gz: 95223e578d503a2e1503dea4f33bcaef04439d98b87c612a6c0c6e46a2710ee8af567c372ad723969a69bd3a309cae14c6f1523555ee3ae78f9420b8bcb9d4d1

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 simpletax.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ismael Abreu
+
+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

@@ -0,0 +1,47 @@
+# Ruby gem for SimpleTax API
+
+SimpleTax (http://gosimpletax.com) is the free, web-based tax software that helps you easily find the most savings and ensures you file an accurate tax return, no matter how complicated your affairs are.
+
+This Ruby library allows you to integrate your application with SimpleTax via it's REST API. It relies on OAuth2 for authorising access to a user's account.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simpletax'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simpletax
+
+## Usage
+
+```ruby
+require 'simpletax'
+
+simpletax = SimpleTax::Client.new redirect_url: 'YOUR_CALLBACK_URL', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET'
+simpletax.authorize_url
+# => "https://secure.gosimpletax.com/o/authorize/?client_id=CLIENT_ID&redirect_uri=YOUR_CALLBACK_URL&response_type=code"
+
+# Authorize it in the browser with the given url
+
+simpletax.fetch_token 'CODE_GOTTEN_FROM_THE_CALLBACK_URL'
+
+simpletax.add_income(2500, description: 'Customer invoice')
+simpletax.add_expense(200, description: 'Photoshop license')
+
+# Now check the result on your SimpleTax account'
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/ismaelga/simpletax/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'simpletax'
+  ARGV.clear
+  IRB.start
+end

data/lib/simpletax.rb

@@ -0,0 +1,102 @@
+require "simpletax/version"
+require 'oauth2'
+
+module SimpleTax
+  BASE_API        = 'https://secure.gosimpletax.com/api/v2/uk'.freeze
+  OAUTH_AUTHZ_URL = 'https://secure.gosimpletax.com/o/authorize/'.freeze
+  OAUTH_TOKEN_URL = 'https://secure.gosimpletax.com/o/token/'.freeze
+
+  class Error < Exception
+    def initialize status
+      super "ServerError #{status}"
+    end
+  end
+
+  class ServerError < Exception; end
+  class NoAccessError < Exception; end
+
+  class Client
+    attr_reader :redirect_url, :token, :api_endpoint
+
+    def initialize(options={})
+      @api_endpoint = options[:site]          || BASE_API
+      @redirect_url = options[:redirect_url]  || raise("Redirect URL needed")
+      client_id     = options[:client_id]     || raise("client_id needed")
+      client_secret = options[:client_secret] || raise("client_secret needed")
+      @client = OAuth2::Client.new(
+        client_id,
+        client_secret,
+        site: api_endpoint,
+        authorize_url: OAUTH_AUTHZ_URL,
+        token_url: OAUTH_TOKEN_URL
+      )
+    end
+
+    def authorize_url
+      @client.auth_code.authorize_url(redirect_uri: redirect_url)
+    end
+
+    def fetch_token(code)
+      @token = @client.auth_code.get_token(code, redirect_uri: redirect_url)
+    end
+
+    def add_income(amount, optionals={})
+      requires_token!
+      description = optionals[:description] || ''
+      date        = optionals[:date]        || today
+      date        = format_date(date)
+
+      data = json_body value: amount, date: date, reference: description
+      parse_response token.post(url('/incomes'), body: data)
+    end
+
+    def add_expense(amount, optionals={})
+      requires_token!
+      description = optionals[:description] || ''
+      date        = optionals[:date]        || today
+      date        = format_date(date)
+
+      data = json_body value: amount, date: date, reference: description
+      parse_response token.post(url('/expenses'), body: data)
+    end
+
+    private
+
+    def json_body params
+      MultiJson.dump fields: params
+    end
+
+    def url(path)
+      "#{api_endpoint}#{path}"
+    end
+
+    def requires_token!
+      raise 'Token needed' unless @token
+    end
+
+    def format_date(date)
+      date.to_date.strftime('%d/%m/%Y')
+    end
+
+    def today
+      Date.today
+    end
+
+    def parse_response resp
+      if resp.status >= 400
+        parse_error resp
+      else
+        resp.parsed
+      end
+    end
+
+    def parse_error resp
+      status = resp.status
+      if status >= 500
+        raise ServerError.new status
+      else
+        raise NoAccessError.new status
+      end
+    end
+  end
+end

data/lib/simpletax/version.rb

@@ -0,0 +1,3 @@
+module Simpletax
+  VERSION = "0.0.1"
+end

data/simpletax.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simpletax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simpletax"
+  spec.version       = Simpletax::VERSION
+  spec.authors       = ["Ismael Abreu"]
+  spec.email         = ["ismaelga@gmail.com"]
+  spec.summary       = %q{Ruby API client to gosimpletax.com}
+  spec.description   = %q{Ruby API client to gosimpletax.com}
+  spec.homepage      = "http://github.com/ismaelga/simpletax"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "multi_json"
+  spec.add_dependency "oauth2"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: simpletax
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ismael Abreu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API client to gosimpletax.com
+email:
+- ismaelga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simpletax.rb
+- lib/simpletax/version.rb
+- simpletax.gemspec
+homepage: http://github.com/ismaelga/simpletax
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby API client to gosimpletax.com
+test_files: []