clearbooks 0.16.3

data/Rakefile

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+# System
+require 'bundler'
+require 'bundler/gem_tasks'
+
+require 'shellwords'
+require 'fileutils'
+require 'yaml'
+
+require 'date'
+require 'ostruct'
+
+require 'ronn'
+require 'rdiscount'
+
+require 'benchmark'
+require 'wicked_pdf'
+
+require 'clearbooks/version'
+
+
+### Project Customization for Thor and Rake
+
+project = YAML.load_file( '.project.yaml' )
+project.each_pair { |name, value| self.instance_variable_set( "@#{name.to_s}", value ) }
+
+
+### General
+
+desc "Generate proper README file from templates" # {{{
+task :readme do |t|
+  source    = "README.md.template"
+  target    = "README.md"
+
+  content      = File.readlines( source ).collect!{ |line| line.rstrip }
+  version   = Clearbooks::VERSION
+
+  content[ content.index( "$Version$" ) ] = "Version " + version if( content.include?( "$Version$" ) )
+  File.write( target, content.join("\n") )
+  puts "(II) #{target.to_s} generated from #{source.to_s}"
+end # }}}
+
+desc "Generate Yardoc documentation for this project" # {{{
+task :yardoc do |t|
+
+  # Define new tags for yardoc to detect
+  tags             = {}
+  tags[ "module" ] = "Module"
+  tags[ "class" ]  = "Class"
+  tags[ "fn" ]     = "Function"
+  tags[ "brief" ]  = "Description"
+
+  # Hide tags we don't want in yardoc output
+  hidden           = %w[module class fn]
+
+  # Construct tag string for CLI command
+  tags_line = ""
+  tags.each_pair { |n,v| tags_line += " --tag #{n.to_s}:\"#{v.to_s}\"" }
+  hidden.each { |h| tags_line += " --hide-tag #{h.to_s}" }
+
+  puts "(II) Generating multi-file yardoc output written to doc/yardoc"
+  system "yard --private --protected --markup-provider=redcarpet --markup=markdown #{tags_line.to_s} -o doc/yardoc lib/**/**/*.rb - LICENSE MAINTAINERS"
+
+  puts "(II) Generating one-file yardoc output written to doc/yardoc_pdf"
+  system "yard --private --protected --markup-provider=redcarpet --markup=markdown --one-file #{tags_line.to_s} -o doc/yardoc_pdf lib/**/**/*.rb - LICENSE MAINTAINERS"
+
+  puts "(II) HTML to PDF written to doc/yardoc_pdf"
+  pdf = WickedPdf.new.pdf_from_string( File.read( "doc/yardoc_pdf/index.html" ) )
+  File.open 'doc/yardoc_pdf/index.pdf', 'wb' do |file|
+    file << pdf
+  end
+
+end # }}}
+
+desc "Generate Yard Graphs for this project" # {{{
+task :yardgraph do |t|
+  basedir = "doc/yard-graph"
+  FileUtils.mkdir_p( basedir )
+  system "yard graph --dependencies --empty-mixins --full > #{basedir.to_s}/graph.dot"
+  system "dot -Tpng #{basedir.to_s}/graph.dot > #{basedir.to_s}/graph.png"
+end # }}}
+
+### Actions
+
+
+### Helper Functions
+
+
+### Load all Rake file tasks
+Dir.glob( "{,lib/}#{@gem_name}/interface/rake/**/*.{rake,rb}" ) { |name| load name }
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/Thorfile

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+# Make sure load path contains local + global
+$LOAD_PATH << '.'
+$LOAD_PATH << 'lib'
+
+
+# System includes
+require 'bundler'
+
+require 'fileutils'
+
+
+# Make Thor scripts debug-able, e.g. ruby -r debug -- Thorfile
+require 'thor' unless defined? Thor::Runner
+require 'thor/rake_compat'
+
+
+require 'clearbooks/version'
+
+# @class        class Default < Thor
+# @brief        Default Tasks for Thor, with thight Rake integration
+class Default < Thor
+
+  include Thor::RakeCompat
+
+  Bundler::GemHelper.install_tasks
+
+  ## Rake Task bindings
+
+  # @fn         def build # {{{
+  # @brief      Build clearbooks gem
+  #
+  desc "build", "Build clearbooks-#{Clearbooks::VERSION}.gem into the pkg directory"
+  def build
+    Rake::Task["build"].execute
+  end # }}}
+
+  # @fn         def clean # {{{
+  # @brief      Clean clearbooks gem generated ressources
+  #
+  desc "clean", "Clean clearbooks-#{Clearbooks::VERSION}.gem generated files from current directories"
+  def clean
+    Rake::Task["clean"].execute
+  end # }}}
+
+  # @fn         def install {{{
+  # @brief      Build and install clearbooks gem into system gems
+  desc "install", "Build and install clearbooks-#{Clearbooks::VERSION}.gem into system gems"
+  def install
+    Rake::Task["install"].execute
+  end # }}}
+
+  # @fn         def release {{{
+  # @brief      Build, Tag and push built gem into internal repository
+  desc "release", "Create tag v#{Clearbooks::VERSION} and build and push clearbooks-#{Clearbooks::VERSION}.gem to internal gems repository"
+  def release
+    not ImplementedError # we can push to rubygems since its closed!
+    # Rake::Task["release"].execute
+  end # }}}
+
+  # @fn         def spec {{{
+  # @brief      Run RSpec unit tests
+  desc "spec", "Run RSpec code examples"
+  def spec
+    exec "rspec spec"
+  end # }}}
+
+end # of class Default
+
+# Project Customization for Thor and Rake
+project = YAML.load_file( '.project.yaml' )
+project.each_pair { |name, value| self.instance_variable_set( "@#{name.to_s}", value ) }
+
+# Load all Thor/Rake file tasks
+Dir.glob( "{,lib/}#{@gem_name}/interface/thor/**/*.{thor,rb}" ) { |name| Thor::Util.load_thorfile name }
+Dir.glob( "{,lib/}#{@gem_name}/interface/rake/**/*.{rake,rb}" ) { |name| load name }
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/bin/clearbooks

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib/', __FILE__)
+
+# System includes
+require 'bundler'
+require 'pry'
+require 'thor' unless defined? Thor::Runner
+
+# Custom includes
+require_relative '../lib/clearbooks'
+
+
+# @class      Clearbooks executable
+# @brief      Main entry point for commandline execution
+class Default < Thor
+
+  default_task :console
+  desc 'console', 'Launch Clearbooks console'
+  def console
+    Clearbooks.pry
+  end
+
+end # of class Default
+
+Default.start( ARGV )
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/clearbooks.gemspec

@@ -0,0 +1,119 @@
+# File: clearbooks.gemspec
+# coding: utf-8
+
+
+# Make sure lib is in Load path
+lib = File.expand_path( '../lib/', __FILE__ )
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?( lib )
+
+# System includes
+require 'date'
+
+# Custom includes
+require 'clearbooks/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name                 = 'clearbooks'
+
+  spec.description          = %q(Unofficial Clear Books PLC (https://www.clearbooks.co.uk) gem handling all interactions of their SOAP API via native Ruby interface)
+  spec.summary              = spec.description
+
+  spec.authors              = [ 'Bjoern Rennhak', 'Oleg Kukareka' ]
+  spec.email                = [ 'bjoern@greylon.com', 'oleg@kukareka.com' ]
+
+  spec.homepage             = 'http://github.com/greylon/clearbooks'
+
+  spec.licenses             = %w[MIT]
+
+  spec.date                 = DateTime.now.to_s.split( 'T' ).first
+  spec.version              = Clearbooks::VERSION
+  spec.platform             = Gem::Platform::RUBY
+
+  spec.metadata             = {
+                                'issue_tracker' =>  'http://github.com/greylon/clearbooks/issues'
+                              }
+
+  spec.bindir               = 'bin'
+  spec.executables          = %w[clearbooks]
+
+  spec.require_paths        = %w[lib]
+
+  spec.files                = %w[
+                                  AUTHORS.md
+                                  CHANGELOG.md
+                                  COPYING.md
+                                  FAQ.md
+                                  LICENSE.md
+                                  MAINTAINERS.md
+                                  Gemfile
+                                  README.md
+                                  Rakefile
+                                  Thorfile
+                                  clearbooks.gemspec
+                                ]
+
+  spec.files                += Dir.glob( 'bin/**/*' )
+
+  spec.files                += Dir.glob( 'lib/**/*.rb' )
+  spec.files                += Dir.glob( 'lib/**/*.thor' )
+
+  spec.files                += Dir.glob( 'spec/**/*' )
+
+  spec.files                += Dir.glob( 'data/**/*' )
+
+  spec.files                += Dir.glob( 'documentation/**/*' )
+
+  spec.files                += Dir.glob( 'examples/**/*' )
+
+  spec.files                += Dir.glob( 'base/**/*' )
+
+  spec.test_files           += Dir.glob( 'test/**/*' )
+  spec.test_files           += Dir.glob( 'spec/**/*' )
+  spec.test_files           += Dir.glob( 'features/**/*' )
+
+  ## Dependencies
+
+  # Ruby VM
+  spec.required_ruby_version  = '>= 1.9'
+
+  # General
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+
+  # Middlewares
+  spec.add_runtime_dependency 'savon', '~> 2.11'
+
+  spec.add_runtime_dependency 'andand', '~> 1.3'
+
+  spec.add_runtime_dependency 'pry', '~> 0.10'
+
+
+  # Post Install
+  spec.post_install_message = <<-EOS
+                                                             
+      ____ _     _____    _    ____  ____   ___   ___  _  ______  
+     / ___| |   | ____|  / \  |  _ \| __ ) / _ \ / _ \| |/ / ___| 
+    | |   | |   |  _|   / _ \ | |_) |  _ \| | | | | | | ' /\___ \ 
+    | |___| |___| |___ / ___ \|  _ <| |_) | |_| | |_| | . \ ___) |
+     \____|_____|_____/_/   \_\_| \_\____/ \___/ \___/|_|\_\____/ 
+                                                             
+
+    (c) #{spec.date.to_s}, All rights reserved
+    Bjoern Rennhak, Greylon Ltd.
+
+    Don't forget to get Clearbooks API key from http://clearbooks.co.uk
+    and save it in ~/.clearbooks/config.yml:
+
+    $ echo "api_key: {your_api_key}" >> ~/.clearbooks/config.yml
+
+    You can also provide the API key in ENV['CLEARBOOKS_API_KEY']:
+
+    $ CLEARBOOKS_API_KEY=your_api_key clearbooks
+
+    Thanks for installing unofficial Clearbooks Gem !
+  EOS
+
+end # of Gem::Specification.new do |s|
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/examples/demo.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Custom include
+require_relative 'clearbooks'
+
+# FIXME:
+#
+# For now please check the README.md file or see the output of YARD.

data/lib/clearbooks.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+
+# Standard library includes
+require 'bundler'
+require 'thor'
+require 'rake'
+
+# Custom library includes
+require_relative 'clearbooks/core_ext'
+require_relative 'clearbooks/error'
+
+
+# @module         module Clearbooks
+# @brief          Clearbooks modules and classes namespace
+module Clearbooks
+
+  DEFAULT_CONFIG = '.clearbooks/config.yml'.freeze
+
+  autoload :Client,         'clearbooks/library/client'
+  autoload :Configuration,  'clearbooks/library/configuration'
+
+  autoload :Base,           'clearbooks/model/base'
+  autoload :Invoice,        'clearbooks/model/invoice'
+  autoload :Item,           'clearbooks/model/item'
+  autoload :Entity,         'clearbooks/model/entity'
+  autoload :Project,        'clearbooks/model/project'
+  autoload :AccountCode,    'clearbooks/model/account_code'
+  autoload :Journal,        'clearbooks/model/journal'
+  autoload :Ledger,         'clearbooks/model/ledger'
+  autoload :Payment,         'clearbooks/model/payment'
+
+  class << self
+
+    # @fn       def client {{{
+    # @brief    Clearbooks client instance. You can use static methods in Clearbooks module instead of referring to the client instance.
+    #
+    # @example  Clearbooks.list_invoices
+    #           # or
+    #           Clearbooks.client.list_invoices
+    def client
+      @client ||= Client.new
+    end # }}}
+
+    # @fn       def config {{{
+    # @brief    Clearbooks configuration
+    #
+    # @return   [Configuration]     Returns Configuration object
+    def config
+      @config ||= Configuration.new
+    end # }}}
+
+    # @fn       def configure {{{
+    # @brief    Use a block syntax to configure the gem
+    #
+    # @return   [Hash]    Returns Configuration object
+    #
+    # @example  Clearbooks.configure do |config|
+    #             config.api_key = 'api_key'
+    #             config.log = true
+    #             config.logger = Logger.new(STDOUT)
+    #           end
+    def configure
+      yield config
+    end # }}}
+
+    # @fn       def method_missing method, *args, &block {{{
+    # @brief    Duck typing response for Clearbooks missing methods behavior
+    #
+    # @param    [String]            method      Some unknown method call on Clearbooks class
+    # @param    [Array]             args        Some given function arguments with given method call
+    # @param    [Explicit Block]    block       Some given block argument with the function and arguments
+    #
+    def method_missing method, *args, &block
+      client.send method, *args, &block
+    end # }}}
+
+    # @fn       def respond_to? *args {{{
+    # @brief    Duck typing response for Clearbooks method queries
+    #
+    # @param    [Array]       args        Function and function parameter argument list
+    #
+    def respond_to? *args
+      super || client.respond_to?(*args)
+    end # }}}
+
+  end # of class << self
+
+end # of module Clearbooks
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/core_ext.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+
+Dir[ "#{File.dirname(__FILE__)}/core_ext/*.rb" ].sort.each do |path|
+  require_relative "core_ext/#{File.basename( path, '.rb' )}"
+end
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/core_ext/array.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+
+# @class        class Array
+# @brief        
+class Array
+
+  class << self
+
+    # @fn         def delete_unless &block {{{
+    # @brief      Inverted #delete_if function for convenience
+    #
+    def delete_unless &block
+      delete_if{ |element| not block.call( element ) }
+    end # }}}
+
+    # @fn         def %(len) {{{
+    # @brief      Chunk array into convienent sub-chunks
+    #
+    # @credit     http://drnicwilliams.com/2007/03/22/meta-magic-in-ruby-presentation/
+    #             direct original source at http://redhanded.hobix.com/bits/matchingIntoMultipleAssignment.html
+    #
+    # now e.g. this is possible
+    #
+    # ["foo0", "foo1", "foo2", "foo3", "foo4", "foo5", "foo6", "foo7", "foo8", "foo9", "foo10"]
+    # [ ["foo0", "foo1", "foo2"], ["foo3", "foo4", "foo5"], ["foo6", "foo7", "foo8"], ["foo9", "foo10"]]
+    #
+    def %(len)
+      inject([]) do |array, x|
+        array << [] if [*array.last].nitems % len == 0
+        array.last << x
+        array
+      end
+    end # }}}
+
+    # @fn         def sum {{{
+    def sum
+      inject( nil ) { |sum,x| sum ? sum+x : x }
+    end # }}}
+
+    # @fn         def mean {{{
+    # @brief      
+    def mean
+      sum / size
+    end # }}}
+
+  end # of class << self
+end # of class Array
+
+
+# vim:ts=2:tw=100:wm=100