freckle_io 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1387e11b8c14ae067534e54d5470eae82ef5e510d5a75a830cf6dc9605d09d6
+  data.tar.gz: 0565a0f129768034f84d3710bc68b8095203c5de7b96c3d9f5fcc0bf5d5a4d27
+SHA512:
+  metadata.gz: f7176e0da91bbb2d138123af6fd79ad9fa27fc9858b6d86cd5173189f62fdad66f94339d3bee9ddb678fc46ad08b7b1c94dd1c38a8dcdfcf41bb2fe67a9faa25
+  data.tar.gz: fdd5edd697332843fa57c132ceec901035a13dbe5fdbbfa5cd62e97b544166fc851a37506023c538129ebd9f26a3f6e3aa8166aaca41ea085cd46d0ee6190b56

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+plugins:
+  rubocop:
+    enabled: true
+    config:
+      file: .rubocop.yml

data/.env.sample

@@ -0,0 +1,3 @@
+FRECKLE_TOKEN={{Insert here the freckle's token API}}
+REAL_FRECKLE_USER_ID={{Insert here a real user id. This variable will use during the test.}}
+FRECKLE_URL={{Insert here an alternative freckle API url}}

data/.env.test.sample

@@ -0,0 +1,3 @@
+FRECKLE_TOKEN=token
+REAL_FRECKLE_USER_ID=12345
+FRECKLE_URL=https://example.com

data/.gitignore

@@ -0,0 +1,5 @@
+.env.*
+!.env.*.sample
+*.gem
+Gemfile.lock
+/coverage/

data/.rubocop.yml

@@ -0,0 +1,67 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "bin/**/*"
+    - ".bundle/**/*"
+    - "bundle/**/*"
+    - "db/schema.rb"
+    - "node_modules/**/*"
+    - "**/*.gemspec"
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - context
+    - describe
+    - feature
+    - it
+    - shared_examples
+    - shared_examples_for
+    - namespace
+    - draw
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Lambda:
+  EnforcedStyle: literal
+Style/NegatedIf:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Layout/MultilineHashBraceLayout:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/*
+    - spec/features/**/*
+RSpec/LetSetup:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Exclude:
+    - spec/features/**/*
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NotToNot:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: true
+  Max: 4

data/.travis.yml

@@ -0,0 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=d2619c7f36e46d99be646a88bdb206f69c90064f2473bc42665c2e489f9bf987
+language: ruby
+cache: bundler
+rvm:
+  - 2.4
+  - 2.5
+before_install: gem install bundler -v 1.16.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - cp .env.test.sample .env.test
+scripts:
+  - bundle exec rspec spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  - false

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug"
+end

data/README.md

@@ -0,0 +1,95 @@
+# freckle-io
+
+[![Build Status](https://travis-ci.com/sirion1987/freckle-io.svg?branch=master)](https://travis-ci.com/sirion1987/freckle-io)
+[![Maintainability](https://api.codeclimate.com/v1/badges/051732f42b5e59d60a5a/maintainability)](https://codeclimate.com/github/sirion1987/Freckle-io/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/051732f42b5e59d60a5a/test_coverage)](https://codeclimate.com/github/sirion1987/Freckle-io/test_coverage)
+
+Yet another Ruby client for the Freckle API
+
+# Usage
+
+1. Configure `.env` file. You must define the `FRECKLE_TOKEN` environment
+variable with your Freckle API token.
+
+E.g.
+
+```
+FRECKLE_TOKEN=123921387213987132987
+```
+
+2. Configure client with:
+
+```ruby
+FreckleIO.configure do |c|
+  c.token = ENV["FRECKLE_TOKEN"]
+  c.url = ENV["FRECKLE_URL"]
+  c.auth_type = :freckle_token
+  c.per_page = 20
+  c.max_concurrency = 5
+end
+```
+
+You can set:
+
+1. `FRECKLE_URL`: the URL of the Freckle API. The default value
+   is `https://api.letsfreckle.com/v2`.
+2. `auth_type`: the authentication type which will use with the server.
+   Currently, the only allowed values is:
+   * `:freckle_token`: uses your Freckle API token.
+3. `per_page`: the number of items included for each page. The default
+   value is 30.
+4. `max_concurrency`: max thread for each requests.
+
+## Example
+
+```ruby
+require 'dotenv'
+require 'freckle-io'
+
+FreckleIO.configure do |c|
+  c.token = ENV["FRECKLE_TOKEN"]
+  c.auth_type = :freckle_token
+  c.max_concurrency = 5
+end
+
+client_users = FreckleIO::Client::Users.new.all
+
+client_users.last_responses.each do |resp|
+  resp.body
+end
+```
+
+# Testing
+
+The test suite uses the [VCR](https://github.com/vcr/vcr) gem.
+
+The contents of the cassettes is anonymized (see spec/spec_helper.rb).
+
+## Regenerating the VCR cassettes
+
+Occasionally, it is a good idea to regenerate the cassettes in order to
+do an end-to-end test.
+
+Make sure you have correctly set the `.env.test` file. Inside this file
+you must specify the keys:
+
+* `FRECKLE_TOKEN`: your Freckle API token;
+* `FRECKLE_URL`: Freckle API url;
+* `REAL_FRECKLE_USER_ID`: a real user id.
+
+```shell
+$ rm -rf spec/fixtures/vcr_cassettes/*
+$ bundle
+$ bundle exec rspec
+```
+
+# Compatibility
+
+This client is set for work with the version 2 (v2) of the Freckle API.
+
+# Supported Ruby Versions
+
+This library is tested against the following Ruby implementations:
+
+* Ruby 2.4
+* Ruby 2.5

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/freckle-io.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name         = "freckle_io"
+  spec.version      = "0.0.3"
+  spec.authors      = ["Domenico Giuseppe Garofoli"]
+  spec.email        = ["sirion1987@gmail.com"]
+
+  spec.summary      = "Yet another Ruby client for the Freckle API"
+  spec.description  = "Yet another Ruby client for the Freckle API"
+  spec.homepage     = "https://github.com/sirion1987/freckle-io"
+  spec.license      = "MIT"
+  spec.require_path = ["lib"]
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.files        = `git ls-files -z`.split("\x0")
+  spec.test_files   = Dir["spec/**/*.rb"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-console"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "dotenv"
+  spec.add_runtime_dependency "dry-validation"
+  spec.add_runtime_dependency "faraday", ">= 0.15.2"
+  spec.add_runtime_dependency "faraday_middleware", ">= 0.12"
+  spec.add_runtime_dependency "typhoeus"
+end

data/icon.svg

@@ -0,0 +1,192 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="210mm"
+   height="297mm"
+   viewBox="0 0 744.09448819 1052.3622047"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="icon .svg">
+  <defs
+     id="defs4">
+    <filter
+       inkscape:collect="always"
+       style="color-interpolation-filters:sRGB"
+       id="filter5884"
+       x="-0.044924623"
+       width="1.0898492"
+       y="-0.090303033"
+       height="1.1806061">
+      <feGaussianBlur
+         inkscape:collect="always"
+         stdDeviation="1.8814091"
+         id="feGaussianBlur5886" />
+    </filter>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="2.0788"
+     inkscape:cx="322.35944"
+     inkscape:cy="483.94209"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     showguides="true"
+     inkscape:guide-bbox="true"
+     inkscape:window-width="2560"
+     inkscape:window-height="1416"
+     inkscape:window-x="0"
+     inkscape:window-y="24"
+     inkscape:window-maximized="1">
+    <sodipodi:guide
+       position="138.3909,650.03318"
+       orientation="0,1"
+       id="guide4136" />
+    <sodipodi:guide
+       position="99.500027,550.02807"
+       orientation="0,1"
+       id="guide4138" />
+    <sodipodi:guide
+       position="249.50768,629.83013"
+       orientation="1,0"
+       id="guide4140" />
+    <sodipodi:guide
+       position="350.01786,625.28444"
+       orientation="1,0"
+       id="guide4142" />
+    <sodipodi:guide
+       position="300.01531,611.1423"
+       orientation="1,0"
+       id="guide4144" />
+    <sodipodi:guide
+       position="300.01531,600.03062"
+       orientation="0,1"
+       id="guide4146" />
+    <sodipodi:guide
+       position="173.74624,624.77936"
+       orientation="0,1"
+       id="guide4148" />
+    <sodipodi:guide
+       position="207.58635,574.77681"
+       orientation="0,1"
+       id="guide4150" />
+    <sodipodi:guide
+       position="274.76149,600.03062"
+       orientation="1,0"
+       id="guide5932" />
+    <sodipodi:guide
+       position="324.76405,600.03062"
+       orientation="1,0"
+       id="guide5934" />
+    <sodipodi:guide
+       position="274.76149,612.50001"
+       orientation="0,1"
+       id="guide5936" />
+    <sodipodi:guide
+       position="262.65153,612.50001"
+       orientation="1,0"
+       id="guide4158" />
+    <sodipodi:guide
+       position="274.76149,587.44152"
+       orientation="0,1"
+       id="guide4160" />
+    <sodipodi:guide
+       position="300.01531,650.03318"
+       orientation="-0.44721366,0.89442716"
+       id="guide4164" />
+    <sodipodi:guide
+       position="350.01786,624.77936"
+       orientation="0.44358884,-0.89623041"
+       id="guide4166" />
+    <sodipodi:guide
+       position="350.01786,574.77681"
+       orientation="0.44358884,-0.89623041"
+       id="guide4168" />
+    <sodipodi:guide
+       position="248.99231,574.77681"
+       orientation="0.43642078,0.89974269"
+       id="guide4170" />
+    <sodipodi:guide
+       position="249.50768,624.77936"
+       orientation="0.44001526,0.89799029"
+       id="guide4172" />
+    <sodipodi:guide
+       position="300.01531,650.03318"
+       orientation="0.45081658,0.89261661"
+       id="guide4174" />
+    <sodipodi:guide
+       position="274.76149,562.27745"
+       orientation="0.43642086,-0.89974265"
+       id="guide4180" />
+  </sodipodi:namedview>
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Livello 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#ffcc00;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 367.12006,444.34163 -12.10996,5.87394 -25.25382,-12.24938 -4.90094,2.30944"
+       id="path4182-0"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#ffaa00;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 367.0279,443.821 -12.10996,5.87394 -25.25382,-12.24938 -4.90094,2.30944"
+       id="path4182-3-6"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:#806600;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;opacity:1;filter:url(#filter5884)"
+       d="m 249.50768,483.58541 50.50763,24.74874 50.00255,-24.74874 -50.00255,-25.25381 z"
+       id="path4166"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:#ffd42a;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;fill-opacity:1"
+       d="m 249.50768,427.58286 50.50763,-25.25382 50.00255,25.25382 -50.00255,24.74874 z"
+       id="path4158"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:#d4aa00;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 249.50768,427.58286 0,50.00255 50.50763,24.74874 0,-50.00255 -50.50763,-24.74874 z"
+       id="path4160"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:#ffcc00;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 300.01531,502.33415 50.00255,-24.74874 0,-50.50763 -50.00255,25.25382 0,50.00255 z"
+       id="path4164"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#ffcc00;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 232.49677,460.76496 12.10996,-5.87394 25.25382,12.24938 4.90094,-2.30944"
+       id="path4182"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#ffaa00;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 232.58893,461.28559 12.10996,-5.87394 25.25382,12.24938 4.90094,-2.30944"
+       id="path4182-3"
+       inkscape:connector-curvature="0" />
+  </g>
+</svg>

data/lib/freckle_io/authentication.rb

@@ -0,0 +1,26 @@
+module FreckleIO
+  module Authentication
+    AUTHENTICATION_TYPE = [
+      :freckle_token
+    ].freeze
+
+    def valid_auth?(type)
+      AUTHENTICATION_TYPE.include? type
+    end
+
+    def authorize_request(request)
+      auth_type = FreckleIO.configuration.auth_type
+
+      case auth_type
+      when :freckle_token
+        request.headers["X-FreckleToken"] = token
+      end
+    end
+
+    private
+
+    def token
+      FreckleIO.configuration.token
+    end
+  end
+end

data/lib/freckle_io/client/entries.rb

@@ -0,0 +1,53 @@
+module FreckleIO
+  module Client
+    class Entries
+      ENTRY_ENDPOINT = "/v2/entries".freeze
+      ALLOWED_KEYS = %i(
+        user_ids
+        description
+        project_ids
+        tag_ids
+        tag_filter_type
+        invoice_ids
+        import_ids
+        from
+        to
+        invoiced
+        invoiced_at_from
+        invoiced_at_to
+        updated_from
+        updated_to
+        billable
+        approved_at_from
+        approved_at_to
+        approved_by_ids
+        per_page
+      ).freeze
+      VALIDATOR_MODULE = "FreckleIO::Validator::Entry".freeze
+
+      def all(params = {})
+        multiple_pages.get(ENTRY_ENDPOINT, params: entry_params(params))
+      end
+
+      # not implemented
+      #
+      # def show(id)
+      #   single_page.get("#{ENTRY_ENDPOINT}/#{id}")
+      # end
+
+      private
+
+      def multiple_pages
+        @multiple_pages ||= Request::MultiplePages.new
+      end
+
+      def entry_params(params)
+        @entry_params = Params.new(
+          params,
+          ALLOWED_KEYS,
+          VALIDATOR_MODULE
+        ).call
+      end
+    end
+  end
+end

data/lib/freckle_io/client/project_groups.rb

@@ -0,0 +1,36 @@
+module FreckleIO
+  module Client
+    class ProjectGroups
+      PROJECT_GROUPS_ENDPOINT = "/v2/project_groups".freeze
+      ALLOWED_KEYS = %i(name project_ids per_page).freeze
+      VALIDATOR_MODULE = "FreckleIO::Validator::ProjectGroup".freeze
+
+      def all(params = {})
+        multiple_pages.get(
+          PROJECT_GROUPS_ENDPOINT,
+          params: project_groups_params(params)
+        )
+      end
+
+      # not implemented
+      #
+      # def show(id)
+      #   single_page.get("#{PROJECT_GROUPS_ENDPOINT}/#{id}")
+      # end
+
+      private
+
+      def multiple_pages
+        @multiple_pages ||= Request::MultiplePages.new
+      end
+
+      def project_groups_params(params)
+        @project_groups_params = Params.new(
+          params,
+          ALLOWED_KEYS,
+          VALIDATOR_MODULE
+        ).call
+      end
+    end
+  end
+end

data/lib/freckle_io/client/projects.rb

@@ -0,0 +1,42 @@
+module FreckleIO
+  module Client
+    class Projects
+      PROJECT_ENDPOINT = "/v2/projects".freeze
+      ALLOWED_KEYS = %i(
+        name
+        project_group_ids
+        billing_increment
+        enabled
+        billable
+        per_page
+      ).freeze
+      VALIDATOR_MODULE = "FreckleIO::Validator::Project".freeze
+
+      def all(params = {})
+        multiple_pages.get(PROJECT_ENDPOINT, params: project_params(params))
+      end
+
+      def show(id)
+        single_page.get("#{PROJECT_ENDPOINT}/#{id}")
+      end
+
+      private
+
+      def multiple_pages
+        @multiple_pages ||= Request::MultiplePages.new
+      end
+
+      def single_page
+        @single_page ||= Request::SinglePage.new
+      end
+
+      def project_params(params)
+        @project_params = Params.new(
+          params,
+          ALLOWED_KEYS,
+          VALIDATOR_MODULE
+        ).call
+      end
+    end
+  end
+end

data/lib/freckle_io/client/tags.rb

@@ -0,0 +1,33 @@
+module FreckleIO
+  module Client
+    class Tags
+      TAG_ENDPOINT = "/v2/tags".freeze
+      ALLOWED_KEYS = %i(name billable per_page).freeze
+      VALIDATOR_MODULE = "FreckleIO::Validator::Tag".freeze
+
+      def all(params = {})
+        multiple_pages.get(TAG_ENDPOINT, params: tag_params(params))
+      end
+
+      # not implemented
+      #
+      # def show(id)
+      #   single_page.get("#{TAG_ENDPOINT}/#{id}")
+      # end
+
+      private
+
+      def multiple_pages
+        @multiple_pages ||= Request::MultiplePages.new
+      end
+
+      def tag_params(params)
+        @tag_params = Params.new(
+          params,
+          ALLOWED_KEYS,
+          VALIDATOR_MODULE
+        ).call
+      end
+    end
+  end
+end

data/lib/freckle_io/client/users.rb

@@ -0,0 +1,35 @@
+module FreckleIO
+  module Client
+    class Users
+      USER_ENDPOINT = "/v2/users".freeze
+      ALLOWED_KEYS = %i(name email role state per_page).freeze
+      VALIDATOR_MODULE = "FreckleIO::Validator::User".freeze
+
+      def all(params = {})
+        multiple_pages.get(USER_ENDPOINT, params: user_params(params))
+      end
+
+      def show(id)
+        single_page.get("#{USER_ENDPOINT}/#{id}")
+      end
+
+      private
+
+      def multiple_pages
+        @multiple_pages ||= Request::MultiplePages.new
+      end
+
+      def single_page
+        @single_page ||= Request::SinglePage.new
+      end
+
+      def user_params(params)
+        @user_params = Params.new(
+          params,
+          ALLOWED_KEYS,
+          VALIDATOR_MODULE
+        ).call
+      end
+    end
+  end
+end