toggl_billable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56d473d435fed4f3fd59cddbdd11489a927291ab
+  data.tar.gz: 91050fe583c99dcbf27ec7ac60a969d0bc572d07
+SHA512:
+  metadata.gz: 626c0f172d331391784ceef8487bd34e399f01a5c884c5aa15fe8945ed5418633feb8656ac0d37374d7263b2ace0bd7fdb74b8b349d946b6930c36660e7826d9
+  data.tar.gz: 7f0bd923e82af581d440b37388b5e13431fa07cabc4a0ec415166a984801ce1ee254ad624e0fad2cb8f96bbf65a0e8095a81f230843972dd424d7f1880f3c7bb

data/lib/core_ext/fixnum.rb

@@ -0,0 +1,9 @@
+class Fixnum
+  DEFAULT_ROUNDING = 0.25
+
+  def to_hours(round=nil)
+    round ||= DEFAULT_ROUNDING
+
+    ((self / 3600000.0) / round).round  * 0.25
+  end
+end

data/lib/toggl_billable/client.rb

@@ -0,0 +1,32 @@
+module TogglBillable
+  class Client
+    def self.start(api_token)
+      @connection = Faraday.new(url: 'https://www.toggle.com') do |faraday|
+        faraday.use Faraday::Request::BasicAuthentication, api_token, 'api_token'
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def self.api_base
+      'https://www.toggl.com/api/v8'
+    end
+
+    def self.reports_base
+      'https://toggl.com/reports/api/v2'
+    end
+
+    def self.connection
+      @connection
+    end
+
+    def self.api_get(end_point)
+      connection.get("#{api_base}/#{end_point}")
+    end
+
+    def self.report_get(end_point)
+      connection.get("#{reports_base}/#{end_point}")
+    end
+
+  end
+end

data/lib/toggl_billable/config.rb

@@ -0,0 +1,16 @@
+module TogglBillable
+  class Config
+    @format_daterange_start = '%b %-d'
+    @format_daterange_end = '%-d'
+    @format_day = '%b %-d'
+    @format_month = '%b'
+
+    class << self
+      attr_accessor :format_daterange_start
+      attr_accessor :format_daterange_end
+      attr_accessor :format_day
+      attr_accessor :format_month
+    end
+
+  end
+end

data/lib/toggl_billable/formatter/base.rb

@@ -0,0 +1,16 @@
+module TogglBillable
+  module Formatter
+    class Base
+      attr_accessor :data, :billable
+
+      NO_CLIENT_KEY = 'NO_CLIENT'
+
+      def initialize(report, options = {})
+        @data     = report['data']
+        @billable = {}
+        @no_client_key = options[:default_client] || NO_CLIENT_KEY
+      end
+
+    end
+  end
+end

data/lib/toggl_billable/formatter/details.rb

@@ -0,0 +1,63 @@
+module TogglBillable
+  module Formatter
+    class Details < Base
+      SKIP_GROUP_DATES = []
+      SHORT_DATES = [nil]
+
+      # TODO: make this working also for different grouping than default
+      def billable_items(with_dates = true)
+        group = data.group_by { |d| d['client'] }
+
+        group.each do |group_name, group_items|
+          key = group_name || @no_client_key
+          billable[key] = [] unless billable[key]
+          subgroup = group_items.group_by { |d| d['project'] }
+
+          subgroup.each do |subgroup_name, subgroup_items|
+            subgroup_items.group_by { |d| d['description'] }.each do |item, data|
+              if with_dates && !SKIP_GROUP_DATES.include?(subgroup_name)
+                task = "#{dates(data, SHORT_DATES.include?(subgroup_name))}: "
+              else
+                task = ''
+              end
+
+              if item && subgroup_name
+                task += "#{subgroup_name}: #{item}"
+              elsif item
+                task += "#{item}"
+              elsif subgroup_name
+                task += "#{subgroup_name}"
+              end
+
+              billable[key] << {
+                task: task,
+                amount: data.map {|i| i['dur']}.reduce(0, :+).to_hours,
+                unit: :hours
+              }
+            end
+          end
+        end
+
+        billable
+      end
+
+      private
+
+      def dates(items, short)
+        start_date = Date.parse(items.sort_by { |i| i['start'] }.first['start'])
+        end_date   = Date.parse(items.sort_by { |i| i['end'] }.reverse.first['end'])
+
+        return start_date.strftime(TogglBillable::Config.format_month).to_s if short
+
+        if start_date.strftime('%-d') == end_date.strftime('%-d')
+          start_date.strftime(TogglBillable::Config.format_day)
+        else
+          start_date = start_date.strftime(TogglBillable::Config.format_daterange_start)
+          end_date = end_date.strftime(TogglBillable::Config.format_daterange_end)
+
+          "#{start_date}-#{end_date}"
+        end
+      end
+    end
+  end
+end

data/lib/toggl_billable/formatter/summary.rb

@@ -0,0 +1,37 @@
+module TogglBillable
+  module Formatter
+    class Summary < Base
+
+      # TODO: make this working also for different grouping than default
+      # TODO: rounding parameter
+      # TODO: implement custom formatting
+      # TODO: projects without names
+      def billable_items
+        data.group_by { |d| d['title']['client'] }.each do |group_name, group_data|
+          key = group_name || @no_client_key
+          billable[key] = [] unless billable[key]
+          group_data.group_by { |d| d['title']['project'] }.each do |subgroup_name, subgroup_data|
+            process_project(subgroup_data.first)
+          end
+        end
+
+        billable
+      end
+
+      private
+
+      def process_project(project_data)
+        project = project_data['title']['project']
+        client  = project_data['title']['client'] || @no_client_key
+
+        project_data['items'].each do |item|
+          billable[client] << {
+            task: "#{project}: #{item['title']['time_entry']}",
+            amount: item['time'].to_hours,
+            unit: :hours
+          }
+        end
+      end
+    end
+  end
+end

data/lib/toggl_billable/reports/base.rb

@@ -0,0 +1,41 @@
+module TogglBillable
+  module Reports
+    class Base
+      attr_accessor :params, :report, :options
+
+      def initialize(options = {})
+        @params = {
+          workspace_id: options[:workspace_id] || User.new.default_workspace_id,
+          user_agent: options[:user_agent] || 'toggl_client'
+        }
+        @options = options
+      end
+
+      def last_month_billable
+        start = DateTime.now.prev_month
+
+        start_date = start.strftime('%Y-%m-01')
+        end_date   = DateTime.civil(start.year, start.month, -1).strftime(('%Y-%m-%d'))
+
+        @report ||= get_report(start_date: start_date, end_date: end_date)
+        billable_items
+      end
+
+      private
+
+      def billable_items
+        params = {}
+        params[:default_client] = options[:default_client] if options[:default_client]
+
+        klass = Object.const_get("TogglBillable::Formatter::#{self.class.to_s.gsub(/^.*::/, '')}")
+        klass.new(report, options).billable_items
+      end
+
+      def hash_to_params
+        return '' unless params
+
+        params.map{ |k, v| "#{k}=#{v}" }.join('&')
+      end
+    end
+  end
+end

data/lib/toggl_billable/reports/details.rb

@@ -0,0 +1,35 @@
+module TogglBillable
+  module Reports
+    class Details < Base
+      def get_report(options = {})
+        params[:since]       = options[:start_date]
+        params[:until]       = options[:end_date]
+        params[:grouping]    = options[:grouping] if options[:grouping]
+        params[:subgrouping] = options[:subgrouping] if options[:grouping]
+        params[:page]        = options[:page] || 1
+        params[:order_field] = options[:oder_field] || 'date'
+        count = 0
+
+        result = {}
+
+        loop do
+          request = "details?user_agent=reports&#{hash_to_params}"
+          response = JSON.parse(Client.report_get(request).body)
+
+          if result.size == 0
+            result = response
+          else
+            result['data'] += response['data']
+          end
+
+          count += response['data'].count
+          break if count >= response['total_count']
+
+          params[:page] += 1
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/toggl_billable/reports/summary.rb

@@ -0,0 +1,15 @@
+module TogglBillable
+  module Reports
+    class Summary < Base
+      def get_report(options)
+        params[:since]       = options[:start_date]
+        params[:until]       = options[:end_date]
+        params[:grouping]    = options[:grouping] if options[:grouping]
+        params[:subgrouping] = options[:subgrouping] if options[:grouping]
+
+        request = "summary?#{hash_to_params}"
+        @report = JSON.parse(Client.report_get(request).body)
+      end
+    end
+  end
+end

data/lib/toggl_billable/user.rb

@@ -0,0 +1,15 @@
+module TogglBillable
+  class User
+
+    def workspaces
+      response = Client.api_get('workspaces')
+      JSON.parse(response.body)
+    end
+
+    def default_workspace_id
+      response = Client.api_get('me')
+      JSON.parse(response.body)['data']['default_wid']
+    end
+
+  end
+end

data/lib/toggl_billable.rb

@@ -0,0 +1,16 @@
+require 'pry'
+require 'faraday'
+require 'json'
+require 'date'
+
+require_relative 'core_ext/fixnum.rb'
+
+require_relative 'toggl_billable/client.rb'
+require_relative 'toggl_billable/config.rb'
+require_relative 'toggl_billable/user.rb'
+require_relative 'toggl_billable/reports/base.rb'
+require_relative 'toggl_billable/reports/summary.rb'
+require_relative 'toggl_billable/reports/details.rb'
+require_relative 'toggl_billable/formatter/base.rb'
+require_relative 'toggl_billable/formatter/details.rb'
+require_relative 'toggl_billable/formatter/summary.rb'

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: toggl_billable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jaroslava Kadlecova
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A simple gem that enables to communicate with toggl API. Main Purpose
+  is to receive items for invoicing.
+email: kadlecovaj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/core_ext/fixnum.rb
+- lib/toggl_billable.rb
+- lib/toggl_billable/client.rb
+- lib/toggl_billable/config.rb
+- lib/toggl_billable/formatter/base.rb
+- lib/toggl_billable/formatter/details.rb
+- lib/toggl_billable/formatter/summary.rb
+- lib/toggl_billable/reports/base.rb
+- lib/toggl_billable/reports/details.rb
+- lib/toggl_billable/reports/summary.rb
+- lib/toggl_billable/user.rb
+homepage: http://github.com/jarkadlec/toggl_billable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Basic operations with toggl API
+test_files: []
+has_rdoc: