frecli 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa2a056d45476409699fa4a851d0cf52f70484bb
+  data.tar.gz: 4322731614f81187010f2a5fe85c819278c2f3cf
+SHA512:
+  metadata.gz: b954dcfcbee6b3f9f7c82f1f57230c974ca594cf889a30c6b058416ddce7c5d0b9bc2baf8c9a4d41a9460e7603d60c88291f827a1b6a543b26cd6f3451afe805
+  data.tar.gz: 25822400a7b82abef2cb660251d68af0f53af1c4f73afd6d797b9383dd2f7c4397195bdd9c5b268c160d1969e6773b452be19387b8ec2b7d4722050283da5e86

data/README.md

@@ -0,0 +1,84 @@
+# FreCLI
+Freckle CLI client in Ruby.
+
+[![Gem Version](https://badge.fury.io/rb/frecli.svg)](https://badge.fury.io/rb/frecli)
+[![Dependency Status](https://gemnasium.com/shkm/frecli.svg)](https://gemnasium.com/shkm/frecli)
+[![Build Status](https://travis-ci.org/shkm/frecli.svg)](https://travis-ci.org/shkm/frecli)
+[![Code Climate](https://codeclimate.com/github/shkm/frecli/badges/gpa.svg)](https://codeclimate.com/github/shkm/frecli)
+[![Test Coverage](https://codeclimate.com/github/shkm/frecli/badges/coverage.svg)](https://codeclimate.com/github/shkm/frecli/coverage)
+
+## What it does right now
+
+This is still very basic and in development, but some functionality works. I'm working on both this and the API client behind it ([freckle-api](https://github.com/shkm/freckle-api)) consecutively.
+
+
+### Projects
+
+- `projects` lists all projects available to you
+- `project ID` list the given project's attributes by its ID.
+
+## Configuration
+
+There are a couple of ways to configure FreCLI.
+
+### Global
+
+A 'global' configuration can be achieved through a `~/.frecli` file or directory. If `~/.frecli` is a file, FreCLI will parse it as YAML. If it's a directory, it will parse and merge settings for all files within.
+
+### Cascading
+
+frecli configuration always cascades down to the current directory. This means that if you have the following directory structure:
+
+```bash
+$HOME/
+|-- .frecli # setting_one: foo, api_key: qwerty1234
+|-- repos/
+   |-- .frecli/
+       |-- settings.yml # setting_one: bar
+       |-- more_settings.yml # setting_two: 2 , api_key: asdf5678
+   |-- project/
+       |-- .frecli # project_setting: my_project
+
+```
+
+and you run FreCLI from `~/repos/project`, your settings will be as follows:
+
+```yml
+setting_one: bar
+setting_two: 2
+api_key: asdf5678
+project_setting: my_project
+```
+
+This will become rather powerful. For example, if you're working on the same project as a team, settings relevant to the project can be added to the project's repository, and everyone in the team will benefit. Such a setting may be the project's ID (though this is not currently implemented), allowing anyone on the team to clock their time on the relevant project when running FreCLI from that project's directory.
+
+### Settings
+
+The following are available as settings.
+
+
+#### `api_key` *required*
+Your Freckle API key. You can get this from the [Freckle site](https://letsfreckle.com) under 'Integrations & apps' -> 'Freckle API'. Just click on 'Settings' next to 'Personal Access Tokens' and create a token for FreCLI.
+
+If you commit your FreCLI settings — with your dotfiles, for example — you can use a more secure approach:
+
+1. Set it as an environment variable: `export FRECKLE_API_KEY="YOURKEY"` in a file which is in your repo's ignore list.
+2. Set it in a YAML file such as `~/.frecli/secrets.yml'`and add it to your repo's ignore list.
+
+Note that for security, you can also set this as an environment variable, which is recommended. Simply add the following to your environment:
+
+```
+export FRECKLE_API_KEY="YOURKEY"
+```
+
+I prefer to put sensitive env variables in `~/.secrets`, with the following in my ~/.profile:
+```
+if [ -f "$HOME/.secrets" ]; then
+  source $HOME/.secrets
+fi
+
+```
+
+## Thanks
+- My work, [Lico Innovations](http://lico.nl/) for using Freckle :-)
+- The awesome Freckle developers — Thomas Cannon in particular — who shared interest in this project and even gave me a free account for testing!

data/bin/frecli

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'frecli/table'
+require 'frecli'
+
+include GLI::App
+include Frecli::Settings
+
+program_desc 'Freckle CLI'
+
+version Frecli::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Manage projects'
+command [:project, :projects, :p] do |c|
+  c.desc 'List all projects'
+  c.command [:all, :a] do |all|
+    all.action do
+      puts Frecli::Table.vertical(
+        Frecli.projects,
+        [ 'ID', 'Name', 'Date created', 'Date updated' ],
+        [ :id, :name, :created_at, :updated_at ]
+      )
+    end
+  end
+
+  c.desc 'Show a project'
+  c.arg :id, :required
+  c.command [:show, :s] do |show|
+    show.action do |_, _, args|
+      id = args[0]
+
+      puts Frecli::Table.horizontal(
+        Frecli.project(id),
+        { ID: :id,
+          Name: :name,
+          Minutes: :minutes }
+      )
+    end
+  end
+
+  c.desc 'Show the currently timed project'
+  c.command [:current, :c] do |current|
+    current.action do
+
+      # TODO: DRY
+      puts Frecli::Table.horizontal(
+        Frecli.project_current,
+        { ID: :id,
+          Name: :name,
+          Minutes: :minutes }
+      )
+    end
+  end
+
+  c.default_command :current
+end
+
+desc 'Manage timers'
+command [:timer, :timers, :t] do |c|
+  c.desc 'List all timers'
+  c.command [:all, :a] do |all|
+    all.action do
+      puts Frecli::Table.vertical(
+        Frecli.timers,
+        [ 'Project ID', 'State', 'Time', 'Date' ],
+        [ -> (timer) { timer.project.id }, :state, :formatted_time, :date ]
+      )
+    end
+  end
+
+  c.desc 'Show a timer'
+  c.arg :id, :required
+  c.command [:show, :s] do |show|
+    show.action do |_, _, args|
+      project_id = args[0]
+
+
+      # TODO: DRY
+      puts Frecli::Table.horizontal(
+        Frecli.timer(project_id),
+        { ID: :id,
+          State: :state,
+          Time: :formatted_time,
+          Description: :description }
+      )
+    end
+  end
+
+  c.desc 'Show the current timer'
+  c.command [:current, :c] do |current|
+    current.action do
+
+      # TODO: DRY
+      puts Frecli::Table.horizontal(
+        Frecli.timer_current,
+        { ID: :id,
+          State: :state,
+          Time: :formatted_time,
+          Description: :description }
+      )
+    end
+  end
+
+  c.default_command :current
+end
+
+
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/frecli.rdoc

@@ -0,0 +1,5 @@
+= frecli
+
+Generate this with
+    frecli rdoc
+After you have described your command line interface

data/lib/frecli.rb

@@ -0,0 +1,9 @@
+require 'frecli/version.rb'
+require 'frecli/settings.rb'
+require 'frecli/queries.rb'
+require 'freckle_api'
+require 'json'
+
+class Frecli
+  include Frecli::Queries
+end

data/lib/frecli/queries.rb

@@ -0,0 +1,43 @@
+class Frecli
+  module Queries
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def api
+        @api = FreckleApi.new(Settings[:api_key])
+      end
+
+      # The project which is currently being timed.
+      def project_current
+        project_id = timer_current.project.id
+
+        # TODO: use a reload method instead.
+        sleep 0.5
+        project(project_id)
+      end
+
+      def projects
+        api.projects
+      end
+
+      def project(id)
+        api.project(id)
+      end
+
+      def timer_current
+        timers.detect { |timer| timer.state == :running }
+      end
+
+      def timers
+        api.timers
+      end
+
+      def timer(project_id)
+        api.timer(project_id)
+      end
+
+    end
+  end
+end

data/lib/frecli/settings.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+
+class Frecli
+  module Settings
+    def self.settings(root_path: '/', reload: false)
+      if reload || !@settings
+        return (@settings = compile_settings(root_path: root_path))
+      end
+
+      @settings
+    end
+
+    def self.[](key)
+      settings[key]
+    end
+
+    # Merges .frecli files down from root dir.
+    # If .frecli is a dir, it will merge all files within.
+    # Relevant ENV vars will always take precedence.
+    def self.compile_settings(root_path: '/')
+      {}.tap do |settings|
+        setting_filenames(root_path: root_path).each do |name|
+          settings.merge!(
+            Hash[YAML.load(File.open name).map { |(k, v)| [k.to_sym, v] }])
+        end
+
+        settings[:api_key] = ENV['FRECKLE_API_KEY'] if ENV.include?('FRECKLE_API_KEY')
+      end
+    end
+
+    def self.setting_filenames(root_path: '/')
+      setting_paths(root_path: root_path).map do |path|
+        filename = join_paths(path, '.frecli')
+
+        next unless File.exist?(filename)
+
+        if File.directory?(filename)
+          Dir.glob(join_paths(filename, '*'))
+        else
+          filename
+        end
+      end.flatten.compact
+    end
+
+    # Return all the paths from root_path to the current dir.
+    #
+    # e.g.
+    # ['/', '/Users', '/Users/isaac', '/Users/isaac/project']
+    def self.setting_paths(root_path: '/')
+      Dir
+        .getwd
+        .sub(root_path, '/')
+        .split('/')
+        .reject(&:empty?)
+        .inject([root_path]) do |path, wd|
+        path << join_paths(path.last, wd)
+      end
+    end
+
+    def self.join_paths(*paths)
+      separator = [*paths].first == '/' ? '' : '/'
+
+      [*paths].join(separator)
+    end
+  end
+end

data/lib/frecli/table.rb

@@ -0,0 +1,61 @@
+require 'terminal-table'
+
+class Frecli
+  module Table
+    # Table where heading is in the first row,
+    # and values are in the columns
+    #
+    # When records  =  [ { id: 1, name: 'Hello', body: 'Hello, world!' } ]
+    #      headings =  'ID', 'Name', 'Body']
+    #      values   =  [ :id, :name, :body]
+    # +----------------------------+
+    # | ID | Name  | Body          |
+    # +----------------------------+
+    # | 1  | Hello | Hello, world! |
+    # +----------------------------+
+    def self.vertical(records, headings, values)
+      Terminal::Table.new do |table|
+
+        table.headings = headings
+        table.rows = records.map do |record|
+          values.map { |value| table_item(record, value)}
+        end
+      end
+    end
+
+    # Table where heading is in the first column,
+    # and value in the second.
+    #
+    # When records = [ { id: 1, name: 'Hello', body: 'Hello, world!' } ]
+    #      items   = [ { ID: :id, Name: :name, Body: :body } ]
+    # +----------------------+
+    # | ID   | 1             |
+    # | Name | Hello         |
+    # | Body | Hello, world! |
+    # +----------------------+
+    def self.horizontal(record, items)
+      Terminal::Table.new do |table|
+        table.rows = items.map do |name, value|
+          [name, table_item(record, value)]
+        end
+      end
+    end
+
+    # When record = { id: 1, name: 'Hello', body: 'Hello, world!' }
+    #
+    #      value  = :id
+    #            => 1
+    #
+    #      value  = -> (record) { record.name.upcase }
+    #            => 'HELLO'
+    #
+    #      value  = 'foo'
+    #            => 'foo'
+    def self.table_item(record, value)
+      return record[value] if value.is_a? Symbol
+      return value[record] if value.respond_to? :call
+
+      value
+    end
+  end
+end

data/lib/frecli/version.rb

@@ -0,0 +1,3 @@
+class Frecli
+  VERSION = '0.3.0'
+end

data/spec/frecli/frecli_spec.rb

@@ -0,0 +1,3 @@
+RSpec.describe 'projects', type: :aruba do
+
+end

data/spec/frecli/settings_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe Frecli::Settings do
+  describe '#settings' do
+    ROOT_PATH = "#{Dir.getwd}/spec/fixtures/settings"
+
+    around(:each) do |spec|
+      dir = [
+        ROOT_PATH,
+        'Users',
+        'isaac',
+        fixture
+      ].join('/')
+
+      Dir.chdir(dir, &spec)
+    end
+
+    let(:settings) { Frecli::Settings.settings(root_path: ROOT_PATH, reload: true) }
+
+    context "when a .frecli file exists only in user's home" do
+      let(:fixture) { 'project_without_settings' }
+
+      it "stores the file's settings" do
+        expect(settings).to eq(api_key: 'the_api_key')
+      end
+    end
+
+    context 'when a .frecli directory exists' do
+      let(:fixture) { 'project_with_frecli_folder' }
+
+      it 'includes settings from all files in the folder' do
+        expect(settings).to eq(
+          api_key: 'the_api_key', # from home
+          setting_one: 1,
+          setting_two: 2
+        )
+      end
+    end
+
+    context 'when .frecli files exist in both home and current dir' do
+      let(:fixture) { 'project_with_settings' }
+
+      it "stores both files' settings" do
+        expect(settings).to eq(api_key: 'the_api_key', foo: 'bar')
+      end
+    end
+
+    context 'when multiple .frecli files exist' do
+      let(:fixture) { 'project_with_override' }
+
+      it 'overrides a previously set setting with the more specific one.' do
+        expect(settings).to eq(api_key: 'overridden_api_key')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'pry'
+require 'pry-byebug'
+require 'aruba/rspec'
+
+require 'frecli'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+
+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
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: frecli
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Jamie Schembri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-02 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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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: 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: 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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: freckle-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+description: 
+email: jamie@schembri.me
+executables:
+- frecli
+extensions: []
+extra_rdoc_files:
+- frecli.rdoc
+files:
+- README.md
+- bin/frecli
+- frecli.rdoc
+- lib/frecli.rb
+- lib/frecli/queries.rb
+- lib/frecli/settings.rb
+- lib/frecli/table.rb
+- lib/frecli/version.rb
+- spec/frecli/frecli_spec.rb
+- spec/frecli/settings_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/shkm/frecli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- frecli
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Command line client for Freckle.
+test_files:
+- spec/frecli/frecli_spec.rb
+- spec/frecli/settings_spec.rb
+- spec/spec_helper.rb