freckle-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d0200c8b4beb472d2099eb324cae42d8f4396f
-  data.tar.gz: be9601b09316bc7c84605b974ad1edcffd2493fa
+  metadata.gz: 98be6621cecd9046aa1ca6e7cadc2d18cb06d5d5
+  data.tar.gz: 4e4d3fd3851320e06c272ff0a2c55cb36edc6c8c
 SHA512:
-  metadata.gz: 41425bebaca7754292b57479ca4a99799f7f4f2ffb5742fccad9acae04a92ce5bc2f11dd9e9a550b22b983859c92a9d14515ffd88b39a73d7f51d658d31dbf2f
-  data.tar.gz: 9c330b1c4bca4160723ff36bf28b9f5200417062e9f334cb5de485e6ab330dda3717a2ceb83cd74a519a7b2a76d738053796f067fc5dc97d14e0dc9c243523a2
+  metadata.gz: aa4806c1107bf017dcced798fcf4221e4b799dcb617028dba6dda176908978364fd0363b63e8f02423a2867c15d5d166ffadc1b6ac552a18972ddeb069521fea
+  data.tar.gz: 0e0849ca3bc1dbaafcd3c7df218fe014d15914ef7ca17d8537011580cd0777f28449f33023e21213a929692cfb36ccd568d75a9221d5c4a97ffd6217f958a731

data/README.md

@@ -1,6 +1,12 @@
 # freckle-api
 Freckle API client for v2.
 
+[![Gem Version](https://badge.fury.io/rb/freckle-api.svg)](https://badge.fury.io/rb/freckle-api)
+[![Dependency Status](https://gemnasium.com/shkm/freckle-api.svg)](https://gemnasium.com/shkm/freckle-api)
+[![Build Status](https://travis-ci.org/shkm/freckle-api.svg)](https://travis-ci.org/shkm/freckle-api)
+[![Code Climate](https://codeclimate.com/github/shkm/freckle-api/badges/gpa.svg)](https://codeclimate.com/github/shkm/freckle-api)
+[![Test Coverage](https://codeclimate.com/github/shkm/freckle-api/badges/coverage.svg)](https://codeclimate.com/github/shkm/freckle-api/coverage)
+
 This is still in development and not ready to use yet.
 
 I intend to implement timing functonality only to begin with,

data/lib/freckle_api.rb

@@ -13,42 +13,56 @@ class FreckleApi
   BASE_URI = URI('https://api.letsfreckle.com/v2').freeze
   USER_AGENT = 'freckle-api' # TODO: make this flexible?
 
+  def self.uri(*path)
+    URI.parse [BASE_URI, *[path]].join('/')
+  end
+
   def initialize(api_key)
     @api_key = api_key
   end
 
   def project(id)
-    Project.new(request :get, uri('projects', id))
+    Project.new(request :get, self.class.uri('projects', id))
   end
 
   def projects
-    request(:get, uri('projects')).map do |project|
-      Project.new(project)
-    end
+    Project.list(request :get, self.class.uri('projects'))
   end
 
+  # TODO: consider whether it's necessary to find a timer by ITS id,
+  # not that of the project.
   def timer(project)
     project_id = project.respond_to?(:id) ? project.id : project
 
-    Timer.new(request :get, uri('projects', project_id, 'timer'))
+    Timer.new(request :get, self.class.uri('projects', project_id, 'timer'))
   end
 
-  private
+  def timers
+    Timer.list(request :get, self.class.uri('timers'))
+  end
 
-  def request(method, uri)
-    https = Net::HTTP.new(uri.host, uri.port).tap { |h| h.use_ssl = true }
+  def request(method, uri, parse: true, params: {})
+    request = build_request(method, uri, params)
+    response = send_request(request, uri)
 
-    response = https.request(http_class(method).new(uri.path, headers))
+    parse ? JSON.parse(response.body) : response
+  end
 
-    JSON.parse(response.body)
+  private
+
+  def build_request(method, uri, params: {})
+    http_class(method).new(uri.path, headers).tap do |request|
+      request.set_form_data(params)
+    end
   end
 
-  def http_class(method)
-    "Net::HTTP::#{method.to_s.capitalize}".constantize
+  def send_request(request, uri)
+    https = Net::HTTP.new(uri.host, uri.port).tap { |h| h.use_ssl = true }
+    https.request(request)
   end
 
-  def uri(*path)
-    URI.parse [BASE_URI, *path].join('/')
+  def http_class(method)
+    Object.const_get "Net::HTTP::#{method.to_s.capitalize}"
   end
 
   def headers

data/lib/freckle_api/coercions.rb

@@ -3,21 +3,23 @@
 #
 # E.g.:
 #   coerce_key, :the_key, name_of_method_that_returns_proc
-#
-module FreckleApi::Coercions
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
+class FreckleApi
+  module Coercions
 
-  module ClassMethods
-    # TODO: timezone based on local machine
-    # TODO: beware nil values
-    def coerce_to_datetime
-      DateTime.method(:parse).to_proc
+    def self.included(base)
+      base.extend(ClassMethods)
     end
 
-    def coerce_to_date
-      Date.method(:parse).to_proc
+    module ClassMethods
+      # TODO: timezone based on local machine
+      # TODO: beware nil values
+      def coerce_to_datetime
+        DateTime.method(:parse).to_proc
+      end
+
+      def coerce_to_date
+        Date.method(:parse).to_proc
+      end
     end
   end
 end

data/lib/freckle_api/group.rb

@@ -1,2 +1,4 @@
-class FreckleApi::Group < FreckleApi::Model
+class FreckleApi
+  class Group < FreckleApi::Model
+  end
 end

data/lib/freckle_api/import.rb

@@ -1,2 +1,4 @@
-class FreckleApi::Import < FreckleApi::Model
+class FreckleApi
+  class Import < FreckleApi::Model
+  end
 end

data/lib/freckle_api/invoice.rb

@@ -1,3 +1,5 @@
-class FreckleApi::Invoice < FreckleApi::Model
-  coerce_key :invoice_date, coerce_to_date
+class FreckleApi
+  class Invoice < FreckleApi::Model
+    coerce_key :invoice_date, coerce_to_date
+  end
 end

data/lib/freckle_api/model.rb

@@ -1,10 +1,20 @@
 require 'hashie'
 
-class FreckleApi::Model < Hash
-  include Hashie::Extensions::Coercion
-  include Hashie::Extensions::MergeInitializer
-  include Hashie::Extensions::MethodAccess
-  include Hashie::Extensions::IndifferentAccess
+class FreckleApi
+  class Model < Hash
+    include Hashie::Extensions::Coercion
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IndifferentAccess
 
-  include FreckleApi::Coercions
+    include FreckleApi::Coercions
+
+    def self.list(*records)
+      [*records].map { |record| new(record) }
+    end
+
+    def reload!(_api)
+      fail NotImplementedError
+    end
+  end
 end

data/lib/freckle_api/project.rb

@@ -1,19 +1,25 @@
-class FreckleApi::Project < FreckleApi::Model
-  coerce_key :group, FreckleApi::Group
-  coerce_key :import, FreckleApi::Import
-  coerce_key :invoices, Array[FreckleApi::Invoice]
-  coerce_key :participants, Array[FreckleApi::User]
+class FreckleApi
+  class Project < FreckleApi::Model
+    coerce_key :group, FreckleApi::Group
+    coerce_key :import, FreckleApi::Import
+    coerce_key :invoices, Array[FreckleApi::Invoice]
+    coerce_key :participants, Array[FreckleApi::User]
 
-  coerce_key :created_at, coerce_to_datetime
-  coerce_key :updated_at, coerce_to_datetime
+    coerce_key :created_at, coerce_to_datetime
+    coerce_key :updated_at, coerce_to_datetime
 
-  # entries is a method of hash, so we're aliasing
-  # it for now. Hashie's MethodWithIndirectAccess
-  # should take care of this, but it doesn't
-  # seem to work in this case, so we do it manually.
-  alias_method :__entries, :entries
+    # entries is a method of hash, so we're aliasing
+    # it for now. Hashie's MethodWithIndirectAccess
+    # should take care of this, but it doesn't
+    # seem to work in this case, so we do it manually.
+    alias_method :__entries, :entries
 
-  def entries
-    self[:entries]
+    def entries
+      self[:entries]
+    end
+
+    def reload!(api)
+      update api.project(FreckleApi.uri('projects', id))
+    end
   end
 end

data/lib/freckle_api/timer.rb

@@ -1,6 +1,43 @@
-class FreckleApi::Timer < FreckleApi::Model
-  coerce_key :state, Symbol
-  coerce_key :date, coerce_to_date
-  coerce_key :user, FreckleApi::User
-  coerce_key :project, FreckleApi::Project
+# TODO: actual error handling
+class FreckleApi
+  class Timer < FreckleApi::Model
+    coerce_key :state, Symbol
+    coerce_key :date, coerce_to_date
+    coerce_key :user, FreckleApi::User
+    coerce_key :project, FreckleApi::Project
+
+    def start!(api)
+      update api.request(:put, timer_uri(:start))
+    end
+
+    def pause!(api)
+      update api.request(:put, timer_uri(:pause))
+    end
+
+    def log!(api, entry_date: nil, minutes: nil, description: nil)
+      response = api.request(:put, timer_uri(:log), parse: false)
+
+      response.code.to_i == 204
+    end
+
+    def discard!(api)
+      api.request(:put, timer_uri(:discard), parse: false)
+
+      response.code.to_i == 204 ? true : nil
+    end
+
+    def reload!(api)
+      response = api.request(:get,
+                             FreckleApi.uri('projects', project.id, 'timer'),
+                             parse: false)
+
+      response.code.to_i == 204 ? update(response.body) : nil
+    end
+
+    private
+
+    def timer_uri(action)
+      FreckleApi.uri('projects', project.id, 'timer', action)
+    end
+  end
 end

data/lib/freckle_api/user.rb

@@ -1,2 +1,4 @@
-class FreckleApi::User < FreckleApi::Model
+class FreckleApi
+  class User < FreckleApi::Model
+  end
 end

data/lib/freckle_api/version.rb

@@ -1,3 +1,3 @@
 class FreckleApi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/freckle_api/timer_spec.rb

@@ -0,0 +1,60 @@
+RSpec.describe FreckleApi::Timer do
+  include_context 'api'
+  let(:timer) { api.timer(existing_project_id) }
+
+  describe '#pause!' do
+    context 'when the timer is running' do
+      before do
+        stub_get_timer(existing_project_id)
+        stub_put_timer_event(existing_project_id, :pause)
+
+        timer.pause!(api)
+      end
+
+      it 'pauses the timer' do
+        expect(timer.state).to eq :paused
+      end
+    end
+  end
+
+  describe '#start!' do
+    context 'when the timer is paused' do
+      before do
+        stub_get_timer(existing_project_id, file: 'pause')
+        stub_put_timer_event(existing_project_id, :start)
+
+        timer.start!(api)
+      end
+
+      it 'starts the timer' do
+        expect(timer.state).to eq :running
+      end
+    end
+  end
+
+  describe '#log!' do
+    context 'when the timer is running' do
+      before do
+        stub_get_timer(existing_project_id)
+        stub_put_timer_log(existing_project_id)
+      end
+
+      let(:result) { timer.log!(api) }
+
+      it 'logs the timer, returning true' do
+        expect(result).to eq true
+      end
+
+      it 'no longer exists' do
+        result
+
+        stub_api(:get, "projects/#{existing_project_id}/timer", status: 404)
+
+        expect(timer.reload!(api)).to be_nil
+      end
+    end
+  end
+
+  describe '#discard!' do
+  end
+end

data/spec/freckle_api_spec.rb

@@ -1,26 +1,26 @@
-require 'spec_helper'
-require 'freckle_api'
-
 RSpec.describe FreckleApi do
-  let(:base_uri) { 'https://api.letsfreckle.com/v2' }
-  let(:api) { FreckleApi.new('valid_api_key') }
+  include_context 'api'
 
   describe '#project' do
     context 'given a valid project id' do
-      let(:project) { api.project(37_396) }
+      let(:project) { api.project(existing_project_id) }
+
+      before do
+        stub_get_project(existing_project_id)
+      end
 
       it 'returns the project' do
         expect(project).to be_a FreckleApi::Project
       end
 
       it 'contains the expected simple values' do
-        expect(project.id).to eq 37_396
+        expect(project.id).to eq existing_project_id
         expect(project.name).to eq 'Gear GmbH'
         expect(project.billing_increment).to eq 10
         expect(project.enabled).to eq true
         expect(project.billable).to eq true
         expect(project.color).to eq '#ff9898'
-        expect(project.url).to eq "#{base_uri}/projects/37396"
+        expect(project.url).to eq "#{base_uri}/projects/#{existing_project_id}"
         expect(project.minutes).to eq 180
         expect(project.billable_minutes).to eq 120
         expect(project.unbillable_minutes).to eq 60
@@ -28,9 +28,9 @@ RSpec.describe FreckleApi do
         expect(project.remaining_minutes).to eq 630
         expect(project.budget_minutes).to eq 750
         expect(project.entries).to eq 0
-        expect(project.entries_url).to eq "#{base_uri}/projects/37396/entries"
+        expect(project.entries_url).to eq "#{base_uri}/projects/#{existing_project_id}/entries"
         expect(project.expenses).to eq 0
-        expect(project.expenses_url).to eq "#{base_uri}/projects/37396/expenses"
+        expect(project.expenses_url).to eq "#{base_uri}/projects/#{existing_project_id}/expenses"
       end
 
       it 'contains the correct coerced timestamps' do
@@ -80,13 +80,13 @@ RSpec.describe FreckleApi do
         participant = project.participants.last
 
         expect(participant).to be_a FreckleApi::User
-        expect(participant.id).to eq 5538
+        expect(participant.id).to eq existing_user_id
         expect(participant.email).to eq 'john.test@test.com'
         expect(participant.first_name).to eq 'John'
         expect(participant.last_name).to eq 'Test'
         expect(participant.profile_image_url).to eq(
           'https://api.letsfreckle.com/images/avatars/0000/0001/avatar.jpg')
-        expect(participant.url).to eq "#{base_uri}/users/5538"
+        expect(participant.url).to eq "#{base_uri}/users/#{existing_user_id}"
       end
     end
   end
@@ -96,6 +96,10 @@ RSpec.describe FreckleApi do
     # of the individual project above.
     let(:projects) { api.projects }
 
+    before do
+      stub_get_projects
+    end
+
     it 'returns a collection of projects' do
       expect(projects).to respond_to(:count)
       expect(projects.count).to eq 1
@@ -104,7 +108,12 @@ RSpec.describe FreckleApi do
   end
 
   describe '#timer' do
-    let(:timer) { api.timer(37_396) }
+    let(:timer) { api.timer(existing_project_id) }
+
+    before do
+      stub_get_project(existing_project_id)
+      stub_get_timer(existing_project_id)
+    end
 
     it 'returns the timer' do
       expect(timer).to be_a FreckleApi::Timer
@@ -115,10 +124,10 @@ RSpec.describe FreckleApi do
       expect(timer.state).to eq :running
       expect(timer.seconds).to eq 180
       expect(timer.description).to eq 'freckle work'
-      expect(timer.url).to eq "#{base_uri}/projects/37396/timer"
-      expect(timer.start_url).to eq "#{base_uri}/projects/37396/timer/start"
-      expect(timer.pause_url).to eq "#{base_uri}/projects/37396/timer/pause"
-      expect(timer.log_url).to eq "#{base_uri}/projects/37396/timer/log"
+      expect(timer.url).to eq "#{base_uri}/projects/#{existing_project_id}/timer"
+      expect(timer.start_url).to eq "#{base_uri}/projects/#{existing_project_id}/timer/start"
+      expect(timer.pause_url).to eq "#{base_uri}/projects/#{existing_project_id}/timer/pause"
+      expect(timer.log_url).to eq "#{base_uri}/projects/#{existing_project_id}/timer/log"
     end
 
     it 'contains the coerced date' do
@@ -129,30 +138,30 @@ RSpec.describe FreckleApi do
       user = timer.user
 
       expect(user).to be_a FreckleApi::User
-      expect(user.id).to eq 5_538
+      expect(user.id).to eq existing_user_id
       expect(user.email).to eq 'john.test@test.com'
       expect(user.first_name).to eq 'John'
       expect(user.last_name).to eq 'Test'
       expect(user.profile_image_url).to eq(
         'https://api.letsfreckle.com/images/avatars/0000/0001/avatar.jpg')
-      expect(user.url).to eq "#{base_uri}/users/5538"
+      expect(user.url).to eq "#{base_uri}/users/#{existing_user_id}"
     end
 
     it 'contains the expected project' do
       project = timer.project
 
       expect(project).to be_a FreckleApi::Project
-      expect(project.id).to eq 37_396
+      expect(project.id).to eq existing_project_id
       expect(project.name).to eq 'Gear GmbH'
       expect(project.billing_increment).to eq 10
       expect(project.enabled).to eq true
       expect(project.billable).to eq true
       expect(project.color).to eq '#ff9898'
-      expect(project.url).to eq "#{base_uri}/projects/37396"
+      expect(project.url).to eq "#{base_uri}/projects/#{existing_project_id}"
     end
 
     context 'when passing an actual project' do
-      let(:timer) { api.timer(api.project(37_396)) }
+      let(:timer) { api.timer(api.project(existing_project_id)) }
 
       it 'returns the timer' do
         expect(timer).to be_a FreckleApi::Timer

data/spec/spec_helper.rb

@@ -1,8 +1,14 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 require 'rspec'
 require 'webmock/rspec'
 require 'pry'
 require 'pry-byebug'
-require 'support/fake_freckle.rb'
+
+require 'freckle_api'
+require 'support/shared_contexts/api.rb'
+require 'support/api_helper.rb'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -73,8 +79,9 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 
-  config.before(:each) do
-    # Thanks https://robots.thoughtbot.com/how-to-stub-external-services-in-tests
-    stub_request(:any, %r{api.letsfreckle.com:443/v2}).to_rack(FakeFreckle)
+  config.include ApiHelper
+
+  config.after(:suite) do
+    WebMock.disable_net_connect!(allow: 'codeclimate.com')
   end
 end

data/spec/support/api_helper.rb

@@ -0,0 +1,44 @@
+module ApiHelper
+  def stub_api(method, remote_path, body: '', file_path: nil, status: 200)
+    headers = {
+      'User-Agent': 'freckle-api',
+      'X-FreckleToken': valid_api_key
+    }
+
+    if file_path
+      body = File.open("spec/fixtures/#{file_path || remote_path}.json").read
+    end
+
+    stub_request(method, [base_uri, remote_path].join('/'))
+      .with(headers: headers)
+      .to_return(status: status, body: body)
+  end
+
+  def stub_get_project(id)
+    stub_api(:get,
+             "projects/#{id}",
+             file_path: 'projects/show')
+  end
+
+  def stub_get_projects
+    stub_api(:get, 'projects', file_path: 'projects')
+  end
+
+  def stub_get_timer(project_id, file: nil)
+    path = 'projects/show/timer'
+    path = [path, file].join('/') if file
+
+    stub_api(:get,
+             "projects/#{project_id}/timer",
+             file_path: path)
+  end
+
+  def stub_put_timer_event(project_id, event)
+    stub_api(:put, "projects/#{project_id}/timer/#{event}",
+             file_path: "projects/show/timer/#{event}")
+  end
+
+  def stub_put_timer_log(project_id)
+    stub_api(:put, "projects/#{project_id}/timer/log", status: 204)
+  end
+end

data/spec/support/shared_contexts/api.rb

@@ -0,0 +1,10 @@
+shared_context 'api' do
+  let(:base_uri) { 'https://api.letsfreckle.com/v2' }
+  let(:valid_api_key) { 'valid_api_key' }
+  let(:invalid_api_key) { 'valid_api_key' }
+
+  let(:existing_project_id) { 37_396 }
+  let(:existing_user_id) { 5_538 }
+
+  let(:api) { FreckleApi.new(valid_api_key) }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freckle-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jamie Schembri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,33 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: sinatra-contrib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -126,9 +112,11 @@ files:
 - lib/freckle_api/timer.rb
 - lib/freckle_api/user.rb
 - lib/freckle_api/version.rb
+- spec/freckle_api/timer_spec.rb
 - spec/freckle_api_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_freckle.rb
+- spec/support/api_helper.rb
+- spec/support/shared_contexts/api.rb
 homepage: http://github.com/shkm/freckle-api
 licenses:
 - MIT
@@ -139,9 +127,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -154,6 +142,8 @@ signing_key:
 specification_version: 4
 summary: Client for Freckle's API V2.
 test_files:
+- spec/freckle_api/timer_spec.rb
 - spec/freckle_api_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_freckle.rb
+- spec/support/api_helper.rb
+- spec/support/shared_contexts/api.rb

data/spec/support/fake_freckle.rb

@@ -1,35 +0,0 @@
-require 'sinatra/base'
-require 'sinatra/namespace'
-
-class FakeFreckle < Sinatra::Base
-  register Sinatra::Namespace
-
-  set :port, 443
-
-  namespace '/v2' do
-    namespace '/projects' do
-      get do
-        json_response 200, 'projects'
-      end
-
-      namespace '/:id' do
-        get do
-          json_response 200, 'projects/37396'
-        end
-
-        get '/timer' do
-          json_response 200, 'projects/37396/timer'
-        end
-      end
-    end
-  end
-
-  private
-
-  def json_response(response_code, file_name)
-    content_type :json
-    status response_code
-
-    File.open("#{File.dirname(__FILE__)}/fixtures/#{file_name}.json", 'rb').read
-  end
-end