kindle_fortune 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd5cccc0f89073b8f906d470cda139f27c2a3e25
+  data.tar.gz: f6d807fdad4c140d5932fcc030292611de5076fa
+SHA512:
+  metadata.gz: 0f21b4405eec3626e985253607cf87887d3bef9211497ff8a559a8d322a152b0f2bc07ddfe28dacfef2922b8ce5b077be3a03ac13c2abca3b5dd85f5e31f2452
+  data.tar.gz: ae10e2b9c5a6096cb638895a5569ffcb58b381d38ab33246373deda6de615562f8bdada3a371b54ba833b343179d72c495ccc1462f66649b84f8f7125c9b87b0

data/.gitignore

@@ -0,0 +1,11 @@
+pkg/
+*.gem
+.bundle/
+.yardoc/
+Gemfile.lock
+/_yardoc/
+*.DS_store
+.rspec_status
+coverage/
+doc/
+docs/

data/.rubocop.yml

@@ -0,0 +1,99 @@
+AllCops:
+  Include:
+    - 'lib/**/*'
+  Exclude:
+    - 'vendor/**/*'
+    - 'benchmarks/*'
+    - 'profile/*'
+    - 'lib/yaml/*'
+    - 'lib/**/*.sh'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.1
+
+# Preferred codebase style ---------------------------------------------
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/ParameterLists:
+  Max: 15
+
+Naming/FileName:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Layout/SpaceAfterComma:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Current preferred metrics --------------------------------------------
+# Better values are encouraged, but not required.
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# TODO -----------------------------------------------------------------
+
+Style/Documentation:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at athityakumar@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contribution guidelines
+
+First of all, thanks for thinking of contributing to this project. :smile:
+
+Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.
+
+- If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
+- If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.
+
+Please proceed with a Pull Request only after you're assigned. It'd be sad if your Pull Request (and your hardwork) isn't accepted just because it isn't ideologically compatible.
+
+# Developing the gem
+
+1. Install with
+
+    ```sh
+    git clone https://github.com/athityakumar/kindle_fortune
+    cd kindle_fortune
+    gem install bundler
+    bundle install
+    ```
+
+2. Make your changes in a different git branch (say, `adds-improvement`). These changes can be
+
+    - fixing existing bugs
+    - improving details displayed
+
+3. (Optional) To test whether `kindle_fortune` executable is working properly, do
+    ```sh
+    rake install
+    ```
+    Then install the gem file in the folder `pkg`. After that to use the new binary,
+    ```sh
+    kindle_fortune # start using kindle_fortune
+    ```
+
+4. Check before pushing
+
+    ```sh
+    bundle exec rubocop
+    bundle exec rspec
+    ```
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Description
+
+Thanks for opening this issue. Add a brief description of what this issue is, and how to recreate it. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to showcase the issue.
+
+- Relevant Issues : (none)
+- Relevant PRs : (none)
+- Type of issue :
+  - [ ] Installation
+  - [ ] Feature request
+  - [ ] Bug in existing feature
+  - [ ] Developer mode : Code quality / Tests / Documentation

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 [Athitya Kumar](https://github.com/athityakumar/)
+
+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/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+### Description
+
+Thanks for contributing this Pull Request. Add a brief description of what this Pull Request does. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to support your changes.
+
+- Relevant Issues : (none)
+- Relevant PRs : (none)
+- Type of change :
+  - [ ] New feature
+  - [ ] Bug fix for existing feature
+  - [ ] Code quality improvement
+  - [ ] Addition or Improvement of tests
+  - [ ] Addition or Improvement of documentation

data/README.md

@@ -0,0 +1,76 @@
+# Kindle Fortune
+
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)
+
+[![Gem Version](https://badge.fury.io/rb/colorls.svg)](https://badge.fury.io/rb/colorls)
+[![Build Status](https://travis-ci.org/athityakumar/colorls.svg?branch=master)](https://travis-ci.org/athityakumar/colorls)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
+
+A Ruby CLI gem that provides fortune cookie messages on your Terminal, based on the highlights on your Kindle device.
+
+# Table of contents
+
+- [Usage](#usage)
+- [Installation](#installation)
+- [Updating](#updating)
+- [Uninstallation](#uninstallation)
+- [Contributing](#contributing)
+- [License](#license)
+
+# Usage
+
+[(Back to top)](#table-of-contents)
+
+1. With default arguments : `kindle_fortune`
+
+![image](https://user-images.githubusercontent.com/17109060/33320930-ca3235a6-d469-11e7-8595-aa628a88a75e.png)
+
+2. With path arguments : `kindle_fortune [PATH]`
+
+`[PATH]` is the absolute path to your `My collections.txt` file of your Kindle device.
+
+# Installation
+
+[(Back to top)](#table-of-contents)
+
+1. Install Ruby (preferably, version > 2.1)
+
+2. Install the [kindle_fortune](https://rubygems.org/gems/kindle_fortune/) ruby gem with `gem install kindle_fortune`
+
+3. Preferably, install the `cowsay` CLI.
+
+4. Start using `kindle_fortune` :tada:
+
+# Updating
+
+[(Back to top)](#table-of-contents)
+
+Want to update to the latest version of `kindle_fortune`?
+
+```sh
+gem update kindle_fortune
+```
+
+# Uninstallation
+
+[(Back to top)](#table-of-contents)
+
+Want to uninstall and revert back to the old style? No issues (sob). Please feel free to open an issue regarding how we can enhance `kindle_fortune`.
+
+```sh
+gem uninstall kindle_fortune
+```
+
+# Contributing
+
+[(Back to top)](#table-of-contents)
+
+Your contributions are always welcome! Please have a look at the [contribution guidelines](CONTRIBUTING.md) first. :tada:
+
+# License
+
+[(Back to top)](#table-of-contents)
+
+
+The MIT License (MIT) 2017 - [Athitya Kumar](https://github.com/athityakumar/). Please have a look at the [LICENSE.md](LICENSE.md) for more details.

data/RELEASE_POLICY.md

@@ -0,0 +1,20 @@
+# Release Policy
+
+Applicable from kindle_fortune v0.0.1 onwards
+
+### Versioning
+
+KindleFortune follows semantic versioning whereby the version number is always in the form MAJOR.MINOR.PATCH
+
+- Patch bump : Bug fixes
+- Minor bump : New features (with backwards compatibility)
+- Major bump : API breaking changes
+
+For Major and Minor bumps release candidates should be released around 2 weeks prior to the bump and are indicated by MAJOR.MINOR.0.rc.
+
+For more information see the full semantic versioning specification at http://semver.org/.
+
+### Release Timing
+
+Patch releases should be done after every fix of a major bug (as tagged in the github issue tracker).
+Major releases should be kept to the minimum.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+task default: %w[spec rubocop]

data/exe/kindle_fortune

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'kindle_fortune'
+puts(KindleFortune.new(updated_datafile: ARGV[0], current_datafile: ARGV[1]).fetch_cookie)

data/kindle_fortune.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kindle_fortune/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kindle_fortune'
+  spec.version       = KindleFortune::VERSION
+  spec.authors       = ['Athitya Kumar']
+  spec.email         = ['athityakumar@gmail.com']
+  spec.summary       = 'A Ruby CLI gem that provides fortune cookie messages on your Terminal, '\
+                       'based on the highlights on your Kindle device.'
+  spec.homepage      = 'https://github.com/athityakumar/kindle_fortune'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = 'kindle_fortune'
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'kindleclippings'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubygems-tasks'
+end

data/lib/kindle_fortune.rb

@@ -0,0 +1,58 @@
+require 'kindle_fortune/version'
+
+require 'json'
+require 'kindleclippings'
+
+class KindleFortune
+  USERNAME                 = `whoami`.strip
+  DEFAULT_UPDATED_DATAFILE = '/Volumes/Kindle/documents/My Clippings.txt'.freeze
+  DEFAULT_CURRENT_DATAFILE = "/Users/#{USERNAME}/.config/kindle_fortune.json".freeze
+
+  def initialize(updated_datafile:, current_datafile:)
+    @current_datafile = current_datafile || DEFAULT_CURRENT_DATAFILE
+    @updated_datafile = updated_datafile || DEFAULT_UPDATED_DATAFILE
+  end
+
+  def fetch_cookie
+    if File.exist?(@updated_datafile) then prepare_extracts
+    else import_extracts
+    end
+
+    raise 'No Kindle highlights detected' unless File.exist?(@current_datafile)
+    fortune_cookie = @extracts[rand(@extracts.count)]
+    pretty_print(fortune_cookie)
+  end
+
+  private
+
+  def import_extracts
+    @extracts = JSON.parse(File.read(@current_datafile))
+  end
+
+  def prepare_extracts
+    @extracts =
+      KindleClippings::Parser
+      .new
+      .parse_file(@updated_datafile)
+      .select { |clipping| clipping.type== :Highlight }
+      .map do |clipping|
+        {
+          'book'     => clipping.book_title,
+          'author'   => clipping.author,
+          'location' => clipping.location,
+          'content'  => clipping.content
+        }
+      end
+    store_extracts
+  end
+
+  def pretty_print(cookie)
+    "#{cookie['book']} (#{cookie['author']}) [L#{cookie['location']}] "\
+    "\n\n #{cookie['content']}"
+  end
+
+  def store_extracts
+    File.delete(@current_datafile) if File.exist?(@current_datafile)
+    File.open(@current_datafile, 'a') { |file| file.write(JSON.pretty_generate(@extracts)) }
+  end
+end

data/lib/kindle_fortune/version.rb

@@ -0,0 +1,3 @@
+class KindleFortune
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: kindle_fortune
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Athitya Kumar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kindleclippings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rspec-its
+  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: rubocop
+  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: rubocop-rspec
+  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: rubygems-tasks
+  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'
+description: 
+email:
+- athityakumar@gmail.com
+executables:
+- kindle_fortune
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- ISSUE_TEMPLATE.md
+- LICENSE.md
+- PULL_REQUEST_TEMPLATE.md
+- README.md
+- RELEASE_POLICY.md
+- Rakefile
+- exe/kindle_fortune
+- kindle_fortune.gemspec
+- lib/kindle_fortune.rb
+- lib/kindle_fortune/version.rb
+homepage: https://github.com/athityakumar/kindle_fortune
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A Ruby CLI gem that provides fortune cookie messages on your Terminal, based
+  on the highlights on your Kindle device.
+test_files: []