freckle-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62d0200c8b4beb472d2099eb324cae42d8f4396f
+  data.tar.gz: be9601b09316bc7c84605b974ad1edcffd2493fa
+SHA512:
+  metadata.gz: 41425bebaca7754292b57479ca4a99799f7f4f2ffb5742fccad9acae04a92ce5bc2f11dd9e9a550b22b983859c92a9d14515ffd88b39a73d7f51d658d31dbf2f
+  data.tar.gz: 9c330b1c4bca4160723ff36bf28b9f5200417062e9f334cb5de485e6ab330dda3717a2ceb83cd74a519a7b2a76d738053796f067fc5dc97d14e0dc9c243523a2

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jamie Schembri
+
+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,30 @@
+# freckle-api
+Freckle API client for v2.
+
+This is still in development and not ready to use yet.
+
+I intend to implement timing functonality only to begin with,
+adding more management features later on. In order to get it to a
+usable/useful state, the following needs to be done:
+
+## TODO
+
+There's a lot to do right now, but to get this API into a useful state
+for users simply logging their time, the following is mandatory:
+
+- Implement timer:
+  - start
+  - pause
+  - log
+  - discard
+
+Longer-term TODO items are, in general order of importance:
+
+- Implement entries
+- Error handling, retry on fail.
+- Rate limiting -- Freckle only allows two requests per second per IP, so consider
+  other users on the network as well. Goes with error handling.
+- The entire v2 API that is currently available
+- Better testing of requests
+- DRYer tests
+- Whatever other TODOs or FIXMEs in the codebase.

data/lib/freckle_api.rb

@@ -0,0 +1,61 @@
+require 'net/http'
+
+require 'freckle_api/coercions.rb'
+require 'freckle_api/model.rb'
+require 'freckle_api/import.rb'
+require 'freckle_api/group.rb'
+require 'freckle_api/invoice.rb'
+require 'freckle_api/user.rb'
+require 'freckle_api/project.rb'
+require 'freckle_api/timer.rb'
+
+class FreckleApi
+  BASE_URI = URI('https://api.letsfreckle.com/v2').freeze
+  USER_AGENT = 'freckle-api' # TODO: make this flexible?
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def project(id)
+    Project.new(request :get, uri('projects', id))
+  end
+
+  def projects
+    request(:get, uri('projects')).map do |project|
+      Project.new(project)
+    end
+  end
+
+  def timer(project)
+    project_id = project.respond_to?(:id) ? project.id : project
+
+    Timer.new(request :get, uri('projects', project_id, 'timer'))
+  end
+
+  private
+
+  def request(method, uri)
+    https = Net::HTTP.new(uri.host, uri.port).tap { |h| h.use_ssl = true }
+
+    response = https.request(http_class(method).new(uri.path, headers))
+
+    JSON.parse(response.body)
+  end
+
+  def http_class(method)
+    "Net::HTTP::#{method.to_s.capitalize}".constantize
+  end
+
+  def uri(*path)
+    URI.parse [BASE_URI, *path].join('/')
+  end
+
+  def headers
+    {
+      'Content-Type' => 'application/json',
+      'User-Agent' => USER_AGENT,
+      'X-FreckleToken' => @api_key
+    }
+  end
+end

data/lib/freckle_api/coercions.rb

@@ -0,0 +1,23 @@
+# Coercions should retain a proc, so that we can easily
+# use them with Hashie's coercion methods.
+#
+# E.g.:
+#   coerce_key, :the_key, name_of_method_that_returns_proc
+#
+module FreckleApi::Coercions
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  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

data/lib/freckle_api/group.rb

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

data/lib/freckle_api/import.rb

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

data/lib/freckle_api/invoice.rb

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

data/lib/freckle_api/model.rb

@@ -0,0 +1,10 @@
+require 'hashie'
+
+class FreckleApi::Model < Hash
+  include Hashie::Extensions::Coercion
+  include Hashie::Extensions::MergeInitializer
+  include Hashie::Extensions::MethodAccess
+  include Hashie::Extensions::IndifferentAccess
+
+  include FreckleApi::Coercions
+end

data/lib/freckle_api/project.rb

@@ -0,0 +1,19 @@
+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]
+
+  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
+
+  def entries
+    self[:entries]
+  end
+end

data/lib/freckle_api/timer.rb

@@ -0,0 +1,6 @@
+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
+end

data/lib/freckle_api/user.rb

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

data/lib/freckle_api/version.rb

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

data/spec/freckle_api_spec.rb

@@ -0,0 +1,162 @@
+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') }
+
+  describe '#project' do
+    context 'given a valid project id' do
+      let(:project) { api.project(37_396) }
+
+      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.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.minutes).to eq 180
+        expect(project.billable_minutes).to eq 120
+        expect(project.unbillable_minutes).to eq 60
+        expect(project.invoiced_minutes).to eq 120
+        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.expenses).to eq 0
+        expect(project.expenses_url).to eq "#{base_uri}/projects/37396/expenses"
+      end
+
+      it 'contains the correct coerced timestamps' do
+        expected_timestamp = DateTime.new(2012, 1, 9, 8, 33, 29)
+
+        expect(project.created_at).to eq expected_timestamp
+        expect(project.updated_at).to eq expected_timestamp
+      end
+
+      it 'contains the expected group' do
+        group = project.group
+
+        expect(group).to be_a FreckleApi::Group
+        expect(group.id).to eq 3768
+        expect(group.name).to eq 'Sprockets, Inc.'
+        expect(group.url).to eq "#{base_uri}/project_groups/3768"
+      end
+
+      it 'contains the expected import' do
+        import = project.import
+
+        expect(import).to be_a FreckleApi::Import
+        expect(import.id).to eq 8910
+        expect(import.url).to eq "#{base_uri}/imports/8910"
+      end
+
+      it 'contains the expected invoices' do
+        expect(project.invoices).to respond_to(:count)
+        expect(project.invoices.count).to eq 1
+
+        invoice = project.invoices.last
+
+        expect(invoice).to be_a FreckleApi::Invoice
+
+        expect(invoice.id).to eq 12_345_678
+        expect(invoice.reference).to eq 'AA001'
+        expect(invoice.invoice_date).to eq Date.new(2013, 7, 9)
+        expect(invoice.state).to eq 'unpaid'
+        expect(invoice.total_amount).to eq 189.33
+        expect(invoice.url).to eq "#{base_uri}/invoices/12345678"
+      end
+
+      it 'contains the expected participants' do
+        expect(project.participants).to respond_to(:count)
+        expect(project.participants.count).to eq 1
+
+        participant = project.participants.last
+
+        expect(participant).to be_a FreckleApi::User
+        expect(participant.id).to eq 5538
+        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"
+      end
+    end
+  end
+
+  describe '#projects' do
+    # Just smoke test for now. We've tested enough
+    # of the individual project above.
+    let(:projects) { api.projects }
+
+    it 'returns a collection of projects' do
+      expect(projects).to respond_to(:count)
+      expect(projects.count).to eq 1
+      expect(projects.last).to be_a FreckleApi::Project
+    end
+  end
+
+  describe '#timer' do
+    let(:timer) { api.timer(37_396) }
+
+    it 'returns the timer' do
+      expect(timer).to be_a FreckleApi::Timer
+    end
+
+    it 'contains the expected simple values' do
+      expect(timer.id).to eq 123_456
+      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"
+    end
+
+    it 'contains the coerced date' do
+      expect(timer.date).to eq Date.new(2013, 7, 9)
+    end
+
+    it 'contains the expected user' do
+      user = timer.user
+
+      expect(user).to be_a FreckleApi::User
+      expect(user.id).to eq 5_538
+      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"
+    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.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"
+    end
+
+    context 'when passing an actual project' do
+      let(:timer) { api.timer(api.project(37_396)) }
+
+      it 'returns the timer' do
+        expect(timer).to be_a FreckleApi::Timer
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'pry'
+require 'pry-byebug'
+require 'support/fake_freckle.rb'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # 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)
+  end
+end

data/spec/support/fake_freckle.rb

@@ -0,0 +1,35 @@
+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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: freckle-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Schembri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: jamie@schembri.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/freckle_api.rb
+- lib/freckle_api/coercions.rb
+- lib/freckle_api/group.rb
+- lib/freckle_api/import.rb
+- lib/freckle_api/invoice.rb
+- lib/freckle_api/model.rb
+- lib/freckle_api/project.rb
+- lib/freckle_api/timer.rb
+- lib/freckle_api/user.rb
+- lib/freckle_api/version.rb
+- spec/freckle_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_freckle.rb
+homepage: http://github.com/shkm/freckle-api
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Client for Freckle's API V2.
+test_files:
+- spec/freckle_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_freckle.rb