togglv8 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a10237427eb728d8536f6276c84e0e83a051695c
-  data.tar.gz: bb81c9c5d1c9a2f1d17b943eefdc1682565da2eb
+  metadata.gz: 7b2c12ae09772a1296677907a4e684d3ad5cfde5
+  data.tar.gz: 5afd4390ec69c38f3a8795e55b9e38a14f96ada7
 SHA512:
-  metadata.gz: 944c4db8f611b45f210a53aba3ad3de9b5ea2c1237d982e4f06fe24637c0e5c6caaacf96ad936d59255d7bc8cb3e03e76a6d66851fbd33a205105f1d9e5cd23b
-  data.tar.gz: a5b4cdc752d55441db098753d4f578d68f7888118686dad90f1fbf79991fab5ffc80f4998ed0d07df81234176077f1511300cb472ab78e41c1123717e0dedb13
+  metadata.gz: 96b68a6420a5751a764a8bb54400be952281958d1325b86581ff39d5faa176807cd235a94795e5eb3802228e7f35bdc12bdda2c0b94b89fd07afbbb4b8844e38
+  data.tar.gz: 2be636c2115bc9be8bb66ebcdedcf8f46be8897d40256deccf96e57af5c7078f5e83a975e58ea133f8ee599b2c263c49fb48cbc2b7ed321952af5c6470860a4c

data/README.md

@@ -45,6 +45,10 @@ toggl_api.create_time_entry({description: "Workspace time entry",
 
 See specs for more examples.
 
+**Note:** Requests are rate-limited. See [Toggl API docs](https://github.com/toggl/toggl_api_docs#the-api-format):
+
+> For rate limiting we have implemented a Leaky bucket. When a limit has been hit the request will get a HTTP 429 response and it's the task of the client to sleep/wait until bucket is empty. Limits will and can change during time, but a safe window will be 1 request per second. Limiting is applied per api token per IP, meaning two users from the same IP will get their rate allocated separately.
+
 ## Documentation
 
 Run `rdoc` to generate documentation. Open `doc/index.html` in your browser.

data/lib/togglv8/time_entries.rb

@@ -73,10 +73,12 @@ module TogglV8
       return formatted_ts.sub('+00:00', 'Z')
     end
 
-    def get_time_entries(start_timestamp=nil, end_timestamp=nil)
+    def get_time_entries(dates = {})
+      start_date = dates[:start_date]
+      end_date = dates[:end_date]
       params = []
-      params.push("start_date=#{iso8601(start_timestamp)}") if !start_timestamp.nil?
-      params.push("end_date=#{iso8601(end_timestamp)}") if !end_timestamp.nil?
+      params.push("start_date=#{iso8601(start_date)}") unless start_date.nil?
+      params.push("end_date=#{iso8601(end_date)}") unless end_date.nil?
       get "time_entries%s" % [params.empty? ? "" : "?#{params.join('&')}"]
     end
 

data/lib/togglv8/users.rb

@@ -33,7 +33,17 @@ module TogglV8
 
     def my_projects(user=nil)
       user = me(all=true) if user.nil?
-      user['projects'] || {}
+      return {} unless user['projects']
+      projects = user['projects']
+      projects.delete_if { |p| p['server_deleted_at'] }
+    end
+
+    # TODO: Test my_deleted_projects
+    def my_deleted_projects(user=nil)
+      user = me(all=true) if user.nil?
+      return {} unless user['projects']
+      projects = user['projects']
+      projects.keep_if { |p| p['server_deleted_at'] }
     end
 
     def my_tags(user=nil)

data/lib/togglv8/version.rb

@@ -1,4 +1,4 @@
 module TogglV8
   # :section:
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/togglv8.rb

@@ -20,6 +20,8 @@ Oj.default_options = { mode: :compat }
 
 module TogglV8
   TOGGL_API_URL = 'https://www.toggl.com/api/'
+  DELAY_SEC = 1
+  MAX_RETRIES = 3
 
   class API
     TOGGL_API_V8_URL = TOGGL_API_URL + 'v8/'
@@ -66,7 +68,6 @@ module TogglV8
       end
     end
 
-
     def requireParams(params, fields=[])
       raise ArgumentError, 'params is not a Hash' unless params.is_a? Hash
       return if fields.empty?
@@ -77,61 +78,56 @@ module TogglV8
       raise ArgumentError, errors.join(', ') if !errors.empty?
     end
 
+    def _call_api(procs)
+      @logger.debug(procs[:debug_output].call)
+      full_resp = nil
+      i = 0
+      loop do
+        i += 1
+        full_resp = procs[:api_call].call
+        @logger.ap(full_resp.env, :debug)
+        break if full_resp.status != 429 || i >= MAX_RETRIES
+        sleep(DELAY_SEC)
+      end
 
-    def get(resource)
-      @logger.debug("GET #{resource}")
-      full_resp = self.conn.get(resource)
-      # @logger.ap(full_resp.env, :debug)
-
-      raise 'Too many requests in a given amount of time.' if full_resp.status == 429
+      raise "HTTP Status: #{full_resp.status}" unless full_resp.status.between?(200,299)
       raise Oj.dump(full_resp.env) unless full_resp.success?
       return {} if full_resp.body.nil? || full_resp.body == 'null'
 
-      resp = Oj.load(full_resp.body)
+      full_resp
+    end
 
+    def get(resource)
+      full_resp = _call_api(debug_output: lambda { "GET #{resource}" },
+                           api_call: lambda { self.conn.get(resource) } )
+      return {} if full_resp == {}
+      resp = Oj.load(full_resp.body)
       return resp['data'] if resp.respond_to?(:has_key?) && resp.has_key?('data')
       resp
     end
 
     def post(resource, data='')
-      @logger.debug("POST #{resource} / #{data}")
-      full_resp = self.conn.post(resource, Oj.dump(data))
-      # @logger.ap(full_resp.env, :debug)
-
-      raise 'Too many requests in a given amount of time.' if full_resp.status == 429
-      raise Oj.dump(full_resp.env) unless full_resp.success?
-      return {} if full_resp.body.nil? || full_resp.body == 'null'
-
+      full_resp = _call_api(debug_output: lambda { "POST #{resource} / #{data}" },
+                           api_call: lambda { self.conn.post(resource, Oj.dump(data)) } )
+      return {} if full_resp == {}
       resp = Oj.load(full_resp.body)
       resp['data']
     end
 
     def put(resource, data='')
-      @logger.debug("PUT #{resource} / #{data}")
-      full_resp = self.conn.put(resource, Oj.dump(data))
-      # @logger.ap(full_resp.env, :debug)
-
-      raise 'Too many requests in a given amount of time.' if full_resp.status == 429
-      raise Oj.dump(full_resp.env) unless full_resp.success?
-      return {} if full_resp.body.nil? || full_resp.body == 'null'
-
+      full_resp = _call_api(debug_output: lambda { "PUT #{resource} / #{data}" },
+                           api_call: lambda { self.conn.put(resource, Oj.dump(data)) } )
+      return {} if full_resp == {}
       resp = Oj.load(full_resp.body)
       resp['data']
     end
 
     def delete(resource)
-      @logger.debug("DELETE #{resource}")
-      full_resp = self.conn.delete(resource)
-      # @logger.ap(full_resp.env, :debug)
-
-      raise 'Too many requests in a given amount of time.' if full_resp.status == 429
-
-      raise Oj.dump(full_resp.env) unless full_resp.success?
-      return {} if full_resp.body.nil? || full_resp.body == 'null'
-
+      full_resp = _call_api(debug_output: lambda { "DELETE #{resource}" },
+                           api_call: lambda { self.conn.delete(resource) } )
+      return {} if full_resp == {}
       full_resp.body
     end
 
   end
-
 end

data/spec/lib/togglv8/time_entries_spec.rb

@@ -83,6 +83,10 @@ describe 'Time Entries' do
       }
       @now = DateTime.now
 
+      start = { 'start' => @toggl.iso8601(@now - 9) }
+      @time_entry_nine_days_ago = @toggl.create_time_entry(time_entry_info.merge(start))
+      @nine_days_ago_id = @time_entry_nine_days_ago['id']
+
       start = { 'start' => @toggl.iso8601(@now - 7) }
       @time_entry_last_week = @toggl.create_time_entry(time_entry_info.merge(start))
       @last_week_id = @time_entry_last_week['id']
@@ -107,23 +111,23 @@ describe 'Time Entries' do
       expect(ids).to eq [ @last_week_id, @now_id ]
     end
 
-    it 'gets time entries after start timestamp (up till now)' do
-      ids = @toggl.get_time_entries(start_timestamp = @now - 1).map { |t| t['id']}
+    it 'gets time entries after start_date (up till now)' do
+      ids = @toggl.get_time_entries({start_date: @now - 1}).map { |t| t['id']}
       expect(ids).to eq [ @now_id ]
     end
 
-    it 'gets time entries before end timestamp' do
-      ids = @toggl.get_time_entries(end_timestamp = @now + 1).map { |t| t['id']}
-      expect(ids).to be_empty
+    it 'gets time entries between 9 days ago and end_date' do
+      ids = @toggl.get_time_entries({end_date: @now + 1}).map { |t| t['id']}
+      expect(ids).to eq [ @last_week_id, @now_id ]
     end
 
-    it 'gets time entries between start and end timestamps' do
-      ids = @toggl.get_time_entries(start_timestamp = @now - 1, end_timestamp = @now + 1).map { |t| t['id']}
+    it 'gets time entries between start_date and end_date' do
+      ids = @toggl.get_time_entries({start_date: @now - 1, end_date: @now + 1}).map { |t| t['id']}
       expect(ids).to eq [ @now_id ]
     end
 
     it 'gets time entries in the future' do
-      ids = @toggl.get_time_entries(start_timestamp = @now - 1, end_timestamp = @now + 8).map { |t| t['id']}
+      ids = @toggl.get_time_entries({start_date: @now - 1, end_date: @now + 8}).map { |t| t['id']}
       expect(ids).to eq [ @now_id, @next_week_id ]
     end
   end

data/spec/lib/togglv8_spec.rb

@@ -1,10 +1,6 @@
 require 'fileutils'
 
 describe 'TogglV8::API' do
-  before :each do
-    sleep(Testing::DELAY_SEC)
-  end
-
   it 'initializes with api_token' do
     toggl = TogglV8::API.new(Testing::API_TOKEN)
     me = toggl.me
@@ -23,7 +19,7 @@ describe 'TogglV8::API' do
 
   it 'does not initialize with bogus api_token' do
     toggl = TogglV8::API.new('4880nqor1orr9n241sn08070q33oq49s')
-    expect { toggl.me } .to raise_error(RuntimeError)
+    expect { toggl.me }.to raise_error(RuntimeError, "HTTP Status: 403")
   end
 
   context '.toggl file' do
@@ -54,6 +50,31 @@ describe 'TogglV8::API' do
     it 'raises error if .toggl file is missing' do
       expect{ toggl = TogglV8::API.new }.to raise_error(RuntimeError)
     end
+  end
+
+  context 'handles errors' do
+    before :all do
+      @toggl = TogglV8::API.new(Testing::API_TOKEN)
+      Response = Struct.new(:env, :status, :success?, :body)
+    end
 
+    it 'surfaces an HTTP Status Code in case of error' do
+      expect(@toggl.conn).to receive(:get).once.and_return(
+        Response.new('', 400, false, nil))
+      expect { @toggl.me }.to raise_error(RuntimeError, "HTTP Status: 400")
+    end
+
+    it 'retries a request up to 3 times if a 429 is received' do
+      expect(@toggl.conn).to receive(:get).exactly(3).times.and_return(
+        Response.new('', 429, false, nil))
+      expect { @toggl.me }.to raise_error(RuntimeError, "HTTP Status: 429")
+    end
+
+    it 'retries a request after 429' do
+      expect(@toggl.conn).to receive(:get).twice.and_return(
+        Response.new('', 429, false, nil),
+        Response.new('', 200, true, nil))
+      expect(@toggl.me).to eq({})   # response is {} in this case because body is nil
+    end
   end
 end

data/spec/spec_helper.rb

@@ -74,12 +74,8 @@ RSpec.configure do |config|
   end
 
   config.before(:suite) do
-    TogglV8SpecHelper.setUp()
-    puts "NOTE: Delaying #{Testing::DELAY_SEC} second(s) between specs to avoid failure due to '429 Too Many Requests'"
-  end
-
-  config.before(:each) do
-    sleep(Testing::DELAY_SEC)
+    toggl = TogglV8::API.new(Testing::API_TOKEN)
+    TogglV8SpecHelper.setUp(toggl)
   end
 
 # The settings below are suggested to provide a good initial experience
@@ -136,5 +132,4 @@ class Testing
   API_TOKEN = '4880adbe1bee9a241fa08070d33bd49f'
   USERNAME  = 'togglv8@mailinator.com'
   PASSWORD  = 'togglv8'
-  DELAY_SEC = 1
 end

data/spec/togglv8_spec_helper.rb

@@ -3,68 +3,72 @@ require 'logger'
 
 class TogglV8SpecHelper
   @logger = Logger.new(STDOUT)
+  @logger.level = Logger::WARN
 
-  def self.setUp()
-    toggl = TogglV8::API.new(Testing::API_TOKEN)
-    user = toggl.me(all=true)
-    default_workspace_id = user['default_wid']
+  def self.setUp(toggl)
+    @toggl = toggl
+    user = @toggl.me(all=true)
+    @default_workspace_id = user['default_wid']
 
-    delete_all_clients(toggl)
-    delete_all_projects(toggl)
-    delete_all_tags(toggl)
-    delete_all_time_entries(toggl)
-    delete_all_workspaces(toggl)
+    delete_all_projects(@toggl)
+    delete_all_clients(@toggl)
+    delete_all_tags(@toggl)
+    delete_all_time_entries(@toggl)
+    delete_all_workspaces(@toggl)
   end
 
   def self.delete_all_clients(toggl)
-    clients = toggl.my_clients
+    clients = @toggl.my_clients
     unless clients.nil?
       client_ids ||= clients.map { |c| c['id'] }
+      @logger.debug("Deleting #{client_ids.length} clients")
       client_ids.each do |c_id|
-        toggl.delete_client(c_id)
+        @toggl.delete_client(c_id)
       end
     end
   end
 
   def self.delete_all_projects(toggl)
-    projects = toggl.my_projects
+    projects = @toggl.projects(@default_workspace_id)
     unless projects.nil?
       project_ids ||= projects.map { |p| p['id'] }
-      project_ids.each do |p_id|
-        toggl.delete_project(p_id)
-      end
+      @logger.debug("Deleting #{project_ids.length} projects")
+      return unless project_ids.length > 0
+      @toggl.delete_projects(project_ids)
     end
   end
 
   def self.delete_all_tags(toggl)
-    tags = toggl.my_tags
-      unless tags.nil?
+    tags = @toggl.my_tags
+    unless tags.nil?
       tag_ids ||= tags.map { |t| t['id'] }
+      @logger.debug("Deleting #{tag_ids.length} tags")
       tag_ids.each do |t_id|
-        toggl.delete_tag(t_id)
+        @toggl.delete_tag(t_id)
       end
     end
   end
 
   def self.delete_all_time_entries(toggl)
-    time_entries = toggl.my_time_entries
+    time_entries = @toggl.my_time_entries
     unless time_entries.nil?
       time_entry_ids ||= time_entries.map { |t| t['id'] }
+      @logger.debug("Deleting #{time_entry_ids.length} time_entries")
       time_entry_ids.each do |t_id|
-        toggl.delete_time_entry(t_id)
+        @toggl.delete_time_entry(t_id)
       end
     end
   end
 
   def self.delete_all_workspaces(toggl)
-    user = toggl.me(all=true)
-    workspaces = toggl.my_workspaces(user)
+    user = @toggl.me(all=true)
+    workspaces = @toggl.my_workspaces(user)
     unless workspaces.nil?
       workspace_ids ||= workspaces.map { |w| w['id'] }
       workspace_ids.delete(user['default_wid'])
+      @logger.debug("Leaving #{workspace_ids.length} workspaces")
       workspace_ids.each do |w_id|
-        @logger.debug(w_id)
-        toggl.leave_workspace(w_id)
+        @toggl.leave_workspace(w_id)
       end
     end
   end

data/togglv8.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "fivemat"
   spec.add_development_dependency "simplecov"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: togglv8
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-22 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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: awesome_print
   requirement: !ruby/object:Gem::Requirement