lolcommits-twitter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d29b0ce9c1c93eb4183c3e2404c380d34e84b2cb
+  data.tar.gz: f6e171d0c20ed403ae919a358f50708fba2e315b
+SHA512:
+  metadata.gz: c921aba53ce4f15d61b566e3365e5eb17ad61bc3a8d062f8a5fe76a95a36ef7b8e1d4d58dc8add4f3fa9c43ca337383d3db77a62931f58641e98a2228b9e117c
+  data.tar.gz: cc25d04b60103d42ee1ae2b65837c618e96e66ef435799f91218f9b08378a208b6e3fb82d9abc42bc783d2c12087daf3ffa6967e0ded473246c2dcae088dcdb5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/vendor/'
+end
+
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+  `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
+end

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+ - 2.0.0
+ - 2.1.7
+ - 2.2.4
+ - 2.3.3
+ - 2.4.1
+ - ruby-head
+
+before_install:
+ - gem install bundler -v 1.13.7
+ - git --version
+ - git config --global user.email "lol@commits.org"
+ - git config --global user.name "Lolcommits"
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+branches:
+  except:
+    - gh-pages

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer via [GitHub][maintainer]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[maintainer]: https://github.com/matthutchinson
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+### Contributing
+
+Pull Requests are welcome! To start helping out:
+
+[Fork](https://guides.github.com/activities/forking) then clone the repository:
+
+    git clone git@github.com:your-username/lolcommits-twitter.git
+
+Create your feature branch:
+
+    git checkout -b my-new-feature
+
+When you are happy with your change, run the full test suite:
+
+    bundle exec rake
+
+With a passing test suite, commit your changes, push and submit a new [Pull
+Request](https://github.com/lolcommits/lolcommits-twitter/compare):
+
+    git commit -am 'Added some feature'
+    git push origin my-new-feature
+
+At this point you'll be waiting for one of our maintainers to review it. We will
+try to reply to new Pull Requests within a few days. We might suggest some
+changes, improvements or alternatives. To increase the chance that your pull
+request gets accepted:
+
+* Explain what your are doing (and why) in your Pull Request description.
+* If you are fixing an
+  [issue](https://github.com/lolcommits/lolcommits-twitter/issues), link to
+  it in your description and [mention
+  it](https://help.github.com/articles/closing-issues-via-commit-messages) in
+  the commit message.
+* Write a good [commit
+  message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* Write tests.
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'lolcommits', path: '/u/code/lolcommits'

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,112 @@
+# Lolcommits Twitter
+
+[![Gem Version](https://img.shields.io/gem/v/lolcommits-twitter.svg?style=flat)](http://rubygems.org/gems/lolcommits-twitter)
+[![Travis Build Status](https://travis-ci.org/lolcommits/lolcommits-twitter.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-twitter)
+[![Coverage Status](https://coveralls.io/repos/github/lolcommits/lolcommits-twitter/badge.svg?branch=master)](https://coveralls.io/github/lolcommits/lolcommits-twitter)
+[![Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-twitter/badges/gpa.svg)](https://codeclimate.com/github/lolcommits/lolcommits-twitter)
+[![Gem Dependency Status](https://gemnasium.com/badges/github.com/lolcommits/lolcommits-twitter.svg)](https://gemnasium.com/github.com/lolcommits/lolcommits-twitter)
+
+[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
+every time you git commit code, and archives a lolcat style image with it. Git
+blame has never been so much fun!
+
+This plugin automatically posts your Lolcommit to Twitter. The tweet features
+your commit message (shortened) and the lolcommit image (along with some
+optional prefix or postfix text). Check out the [#lolcommits
+hashtag](https://twitter.com/hashtag/lolcommits) for examples.
+
+You can optionally open the new tweet in your default browser.
+
+## Requirements
+
+* Ruby >= 2.0.0
+* A webcam
+* [ImageMagick](http://www.imagemagick.org)
+* [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing
+
+## Installation
+
+After installing the lolcommits gem, install this plugin with:
+
+    $ gem install lolcommits-twitter
+
+Next configure the plugin to authenticate with Twitter and set tweeting options.
+
+    $ lolcommits --config -p twitter
+    # set enabled to `true` (then set your own options or choose the defaults)
+
+### Configuration
+
+The following options are available:
+
+* prefix
+* suffix (default: #lolcommits)
+* auto-open tweet url?
+
+You can always reconfigure the plugin without having to re-authenicate with
+Twitter.
+
+To disable - set `enabled: false` and you can always revoke access to your
+twitter account [here](https://twitter.com/settings/applications).
+
+## Development
+
+Check out this repo and run `bin/setup`, to install all dependencies and
+generate docs. Run `bundle exec rake` to run all tests and generate a coverage
+report.
+
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment with the gem code.
+
+## Tests
+
+MiniTest is used for testing. Run the test suite with:
+
+    $ rake test
+
+## Docs
+
+Generate docs for this gem with:
+
+    $ rake rdoc
+
+## Troubles?
+
+If you think something is broken or missing, please raise a new
+[issue](https://github.com/lolcommits/lolcommits-twitter/issues). Take
+a moment to check it hasn't been raised in the past (and possibly closed).
+
+## Contributing
+
+Bug [reports](https://github.com/lolcommits/lolcommits-twitter/issues) and [pull
+requests](https://github.com/lolcommits/lolcommits-twitter/pulls) are welcome on
+GitHub.
+
+When submitting pull requests, remember to add tests covering any new behaviour,
+and ensure all tests are passing on [Travis
+CI](https://travis-ci.org/lolcommits/lolcommits-twitter). Read the
+[contributing
+guidelines](https://github.com/lolcommits/lolcommits-twitter/blob/master/CONTRIBUTING.md)
+for more details.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct. See
+[here](https://github.com/lolcommits/lolcommits-twitter/blob/master/CODE_OF_CONDUCT.md)
+for more details.
+
+## License
+
+The gem is available as open source under the terms of
+[LGPL-3](https://opensource.org/licenses/LGPL-3.0).
+
+## Links
+
+* [Travis CI](https://travis-ci.org/lolcommits/lolcommits-twitter)
+* [Test Coverage](https://coveralls.io/github/lolcommits/lolcommits-twitter)
+* [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-twitter)
+* [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-twitter)
+* [Issues](http://github.com/lolcommits/lolcommits-twitter/issues)
+* [Report a bug](http://github.com/lolcommits/lolcommits-twitter/issues/new)
+* [Gem](http://rubygems.org/gems/lolcommits-twitter)
+* [GitHub](https://github.com/lolcommits/lolcommits-twitter)

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+# generate docs
+RDoc::Task.new do |rd|
+  rd.main     = "README.md"
+  rd.title    = "Lolcommits Twitter"
+  rd.rdoc_dir = "doc"
+  rd.options  << "--all"
+  rd.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
+end
+
+# run tests
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+# run tests with code coverage (default)
+namespace :test do
+  desc "Run all tests and features and generate a code coverage report"
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].execute
+  end
+end
+
+
+task :default => ['test:coverage']

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lolcommits/twitter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+# install deps
+bundle install
+
+# generate docs
+bundle exec rake rdoc

data/lib/lolcommits/plugin/twitter.rb

@@ -0,0 +1,186 @@
+require 'lolcommits/plugin/base'
+require 'lolcommits/cli/launcher'
+require 'lolcommits/twitter/client'
+
+module Lolcommits
+  module Plugin
+    class Twitter < Base
+
+      DEFAULT_SUFFIX  = '#lolcommits'.freeze
+
+      ##
+      # Returns the name of the plugin. Identifies the plugin to lolcommits.
+      #
+      # @return [String] the plugin name
+      #
+      def self.name
+        'twitter'
+      end
+
+      ##
+      # Returns position(s) of when this plugin should run during the capture
+      # process. We want to post to Twitter when the capture is ready (after all
+      # image processing is complete).
+      #
+      # @return [Array] the position(s)
+      #
+      def self.runner_order
+        [:capture_ready]
+      end
+
+      ##
+      # Plugin is configured when a token and token secret exist
+      #
+      # @return [Boolean] true/false if the plugin has been configured
+      #
+      def configured?
+        !!(configuration['token'] && configuration['token_secret'])
+      end
+
+      ##
+      # Prompts the user to configure plugin options.
+      # Options are enabled (true/false), Twitter auth, and prefix/suffix text.
+      #
+      # @return [Hash] a hash of configured plugin options
+      #
+      def configure_options!
+        options = super
+        # ask user to configure all options (if enabling)
+        if options['enabled']
+          auth_config = configure_auth!
+          return unless auth_config
+          options = options.merge(auth_config).
+            merge(configure_prefix_suffix).
+            merge(configure_open_tweet_url)
+        else
+          # retain config when disabling
+          options = configuration.merge(options)
+        end
+        options
+      end
+
+      ##
+      # Capture ready hook, runs after lolcommits captures a snapshot and image
+      # processing has completed.
+      #
+      # Posts the lolcommit to Twitter, first uploading the capture media, then
+      # posting a new Tweet with the media_id attached.
+      #
+      def run_capture_ready
+        status = build_tweet(runner.message)
+        file   = File.open(runner.main_image, 'rb')
+
+        print "Tweeting ... "
+
+        begin
+          client = twitter_client.new(
+            configuration['token'],
+            configuration['token_secret']
+          )
+
+          debug "--> Uploading media (#{file.size} bytes)"
+          media_id = client.upload_media(file)
+          debug "--> Posting status update (#{status.length} chars, media_id: #{media_id})"
+          status_response = client.update_status(status, media_ids: [media_id])
+
+          tweet_url = status_response['entities']['media'][0]['url']
+          print "#{tweet_url}\n"
+          open_url(tweet_url) if configuration['open_tweet_url']
+        rescue StandardError => e
+          puts "ERROR: Tweeting FAILED! - #{e.message}"
+        end
+      end
+
+      private
+
+      def twitter_client
+        Lolcommits::Twitter::Client
+      end
+
+      def build_tweet(commit_message)
+        prefix = configuration['prefix'].to_s
+        suffix = configuration['suffix'].to_s
+        prefix = "#{configuration['prefix']} " unless prefix.empty?
+        suffix = " #{configuration['suffix']}" unless suffix.empty?
+
+        available_commit_msg_size = twitter_client::MAX_TWEET_CHARS - (prefix.length + suffix.length)
+        if commit_message.length > available_commit_msg_size
+          commit_message = "#{commit_message[0..(available_commit_msg_size - 3)]}..."
+        end
+
+        "#{prefix}#{commit_message}#{suffix}"
+      end
+
+      def ask_yes_or_no?(default: false)
+        yes_or_no = parse_user_input(gets.strip)
+        return default if yes_or_no.nil?
+        !!(yes_or_no =~ /^y/i)
+      end
+
+      def configure_auth!
+        if configured?
+          print "\n* Reset Twitter Auth ? (y/N): "
+          return configuration.select {|k,v| k =~ /^token/ } if !ask_yes_or_no?
+        end
+
+        puts ''
+        puts '-----------------------------------'
+        puts '    OK, lets setup Twitter Auth    '
+        puts '-----------------------------------'
+
+        request_token = twitter_client.oauth_consumer.get_request_token
+        rtoken        = request_token.token
+        rsecret       = request_token.secret
+        authorize_url = request_token.authorize_url
+
+        open_url(authorize_url)
+        print "\n* Grab a PIN from this url:\n\n"
+        puts "   #{authorize_url}"
+
+        print "\n* Type PIN, then press Enter: "
+        twitter_pin = gets.strip.downcase.to_s
+
+        begin
+          debug "Requesting Twitter OAuth Token with PIN: #{twitter_pin}"
+          access_token = request_token.get_access_token(oauth_verifier: twitter_pin)
+        rescue OAuth::Unauthorized
+          puts "\nERROR: Twitter PIN Auth FAILED!"
+          return
+        end
+
+        return unless access_token.token && access_token.secret
+
+        puts ''
+        puts '-----------------------------------'
+        puts '  Thanks, Twitter Auth Succeeded!  '
+        puts '-----------------------------------'
+
+        {
+          'token'        => access_token.token,
+          'token_secret' => access_token.secret
+        }
+      end
+
+      def configure_prefix_suffix
+        print "\n* Prefix all tweets with something? e.g. @user (default: nothing): "
+        prefix = gets.strip
+        print "\n* End all tweets with something? e.g. #hashtag (default: #{DEFAULT_SUFFIX}): "
+        suffix = gets.strip
+
+        config = {}
+        config['prefix'] = prefix.empty? ? '' : prefix
+        config['suffix'] = suffix.empty? ? DEFAULT_SUFFIX : suffix
+        config
+      end
+
+      def configure_open_tweet_url
+        print "\n* Automatically open Tweet URL after posting (y/N): "
+        { 'open_tweet_url' => ask_yes_or_no? }
+      end
+
+      def open_url(url)
+        Lolcommits::CLI::Launcher.open_url(url)
+      end
+    end
+  end
+end

data/lib/lolcommits/twitter/client.rb

@@ -0,0 +1,152 @@
+require 'oauth'
+require 'simple_oauth'
+require 'rest_client'
+require 'addressable/uri'
+
+module Lolcommits
+  module Twitter
+    class Client
+
+      API_ENDPOINT     = 'https://api.twitter.com'.freeze
+      UPLOAD_ENDPOINT  = 'https://upload.twitter.com'.freeze
+      CONSUMER_KEY     = 'CwMCjbxREk5dSloZeR5Uhb1Fe'.freeze
+      CONSUMER_SECRET  = 'UfgIvD32rRgSwIWZq9hjADMYd0e3ax9FluSEePSNOqgmSCerU5'.freeze
+
+      CHUNK_SIZE_BYTES = 5_000_000
+      MAX_TWEET_CHARS  = (140 - 1 - 24).freeze # (140 - space - reserved media chars)
+
+      def self.oauth_consumer
+        OAuth::Consumer.new(
+          CONSUMER_KEY,
+          CONSUMER_SECRET,
+          site: API_ENDPOINT,
+          request_endpoint: API_ENDPOINT,
+          sign_in: true
+        )
+      end
+
+      def initialize(token, token_secret)
+        @oauth_credentials = {
+          consumer_key: CONSUMER_KEY,
+          consumer_secret: CONSUMER_SECRET,
+          token: token,
+          token_secret: token_secret
+        }
+      end
+
+      # @see https://dev.twitter.com/rest/reference/post/statuses/update
+      def update_status(status, media_ids: [])
+        url = API_ENDPOINT + "/1.1/statuses/update.json"
+        post(url, params: { status: status, media_ids: media_ids })
+      end
+
+      # @see https://dev.twitter.com/rest/public/uploading-media
+      def upload_media(media)
+        response = begin
+          # upload animated gifs in 5MB chunks
+          if File.basename(media) =~ /\.gif$/
+            upload_media_chunked(media)
+          else
+            post(upload_url, payload: { media: media })
+          end
+        end
+        response['media_id_string']
+      end
+
+      # @see https://dev.twitter.com/rest/public/uploading-media
+      def upload_media_chunked(media)
+        media_id = upload('INIT', {
+          media_type: 'image/gif',
+          media_category: 'tweet_gif',
+          total_bytes: media.size
+        })['media_id_string']
+
+        until media.eof?
+          seg ||= -1
+          base64_chunk = Base64.encode64(media.read(CHUNK_SIZE_BYTES))
+          base64_chunk.delete("\n")
+          upload('APPEND', {
+            media_id: media_id,
+            segment_index: seg += 1,
+            media_data: base64_chunk
+          })
+        end
+        media.close
+
+        finalize = upload('FINALIZE', media_id: media_id)
+
+        # check STATUS if this is an async media upload
+        # @see https://dev.twitter.com/rest/reference/get/media/upload-status
+        processing = finalize['processing_info']
+        if processing
+          until processing['state'] == 'succeeded'
+            sleep processing['check_after_secs'] || 0.5
+            processing = upload_status(media_id)['processing_info']
+          end
+        end
+
+        finalize
+      end
+
+
+      private
+
+      attr_reader :oauth_credentials
+
+      def upload_url
+        @upload_url ||= UPLOAD_ENDPOINT + "/1.1/media/upload.json"
+      end
+
+      # @see https://dev.twitter.com/rest/public/uploading-media
+      def upload(command, payload = {})
+        post(upload_url, payload: payload.merge(command: command))
+      end
+
+      # @see https://dev.twitter.com/rest/reference/get/media/upload-status
+      def upload_status(media_id)
+        get(upload_url, params: { command: 'STATUS', media_id: media_id })
+      end
+
+      def get(url, params: {})
+        uri = Addressable::URI.parse(url)
+        uri.query_values = params
+
+        RestClient.get(uri.to_s, { Authorization: oauth_auth_header(uri) }) do |response, request, result|
+          handle_response(response)
+        end
+      end
+
+      def post(url, params: {}, payload: {})
+        uri = Addressable::URI.parse(url)
+        uri.query_values = params
+
+        payload = payload.merge!(multipart: true) unless payload.empty?
+
+        RestClient.post(uri.to_s, payload, Authorization: oauth_auth_header(uri, :post)) do |response, request, result|
+          handle_response(response)
+        end
+      end
+
+      def handle_response(response)
+        return if response.empty? && response.code.to_s =~ /^2/ # an empty OK response
+
+        parsed_response = JSON.parse(response)
+        if response.code.to_s =~ /^2/
+          return parsed_response
+        else
+          error_message = 'request failed'
+          errors = parsed_response['errors']
+          if errors
+            error_message = errors.map { |err| "Error #{err['code']}: #{err['message']}" }.join(',')
+          end
+          raise StandardError.new(error_message)
+        end
+      end
+
+      def oauth_auth_header(url, method = :get)
+        uri = Addressable::URI.parse(url)
+        SimpleOAuth::Header.new(method, uri, {}, oauth_credentials)
+      end
+    end
+  end
+end

data/lib/lolcommits/twitter/version.rb

@@ -0,0 +1,5 @@
+module Lolcommits
+  module Twitter
+    VERSION = "0.0.1".freeze
+  end
+end

data/lib/lolcommits/twitter.rb

@@ -0,0 +1,2 @@
+require 'lolcommits/twitter/version'
+require 'lolcommits/plugin/twitter'

data/lolcommits-twitter.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lolcommits/twitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lolcommits-twitter"
+  spec.version       = Lolcommits::Twitter::VERSION
+  spec.authors       = ["Matthew Hutchinson"]
+  spec.email         = ["matt@hiddenloop.com"]
+  spec.summary       = %q{Post lolcommits to Twitter}
+  spec.description   = %q{Automatically tweet your lolcommits}
+
+  spec.homepage      = "https://github.com/lolcommits/lolcommits-twitter"
+  spec.license       = "LGPL-3"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
+  spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_runtime_dependency "rest-client"
+  spec.add_runtime_dependency "simple_oauth"
+  spec.add_runtime_dependency "addressable"
+
+  spec.add_development_dependency "lolcommits", ">= 0.9.5"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

data/test/lolcommits/plugin/twitter_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+describe Lolcommits::Plugin::Twitter do
+
+  include Lolcommits::TestHelpers::GitRepo
+  include Lolcommits::TestHelpers::FakeIO
+
+  def plugin_name
+    'twitter'
+  end
+
+  it 'should have a name' do
+    ::Lolcommits::Plugin::Twitter.name.must_equal plugin_name
+  end
+
+  it 'should run on post capturing' do
+    ::Lolcommits::Plugin::Twitter.runner_order.must_equal [:capture_ready]
+  end
+
+  describe 'with a runner' do
+    def runner
+      # a simple lolcommits runner with an empty configuration Hash
+      @_runner ||= Lolcommits::Runner.new(
+        config: OpenStruct.new(read_configuration: {})
+      )
+    end
+
+    def valid_enabled_config
+      @_valid_enabled_config ||= OpenStruct.new(
+        read_configuration: {
+          plugin.class.name => {
+            'enabled'      => true,
+            'token'        => 'abc-xyz',
+            'token_secret' => '123XYZ'
+          }
+        }
+      )
+    end
+
+    def plugin
+      @_plugin ||= Lolcommits::Plugin::Twitter.new(runner: runner)
+    end
+
+    def twitter_client
+      Lolcommits::Twitter::Client
+    end
+
+    describe 'initalizing' do
+      it 'should assign runner and an enabled option' do
+        plugin.runner.must_equal runner
+        plugin.options.must_equal ['enabled']
+      end
+    end
+
+    describe '#enabled?' do
+      it 'should be false by default' do
+        plugin.enabled?.must_equal false
+      end
+
+      it 'should true when configured' do
+        plugin.config = valid_enabled_config
+        plugin.enabled?.must_equal true
+      end
+    end
+
+    describe 'configuration' do
+      it 'should not be configured by default' do
+        plugin.configured?.must_equal false
+      end
+
+      it 'should indicate when configured' do
+        plugin.config = valid_enabled_config
+        plugin.configured?.must_equal true
+      end
+
+      it 'should allow plugin options to be configured' do
+        stub_request(:post, "#{Lolcommits::Twitter::Client::API_ENDPOINT}/oauth/request_token").
+          to_return(status: 200, body: "oauth_token=mytoken&oauth_token_secret=mytokensercet&oauth_callback_confirmed=true")
+
+        stub_request(:post, "#{Lolcommits::Twitter::Client::API_ENDPOINT}/oauth/access_token").
+          to_return(status: 200, body: "oauth_token=oauthtoken&oauth_token_secret=oauthtokensecret&user_id=6253282&screen_name=twitterapi")
+
+        # enabled, AUTH PIN, prefix, suffix, Yes/No auto open
+        inputs = %w(true 123456 LOL-prefix LOL-suffix Y)
+
+        configured_plugin_options = {}
+        fake_io_capture(inputs: inputs) do
+          configured_plugin_options = plugin.configure_options!
+        end
+
+        configured_plugin_options.must_equal({
+          'enabled'        => true,
+          'token'          => 'oauthtoken',
+          'token_secret'   => 'oauthtokensecret',
+          'prefix'         => 'LOL-prefix',
+          'suffix'         => 'LOL-suffix',
+          'open_tweet_url' => true
+        })
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# necessary libs from lolcommits (allowing plugin to run)
+require 'git'
+require 'lolcommits/runner'
+require 'lolcommits/vcs_info'
+require 'lolcommits/backends/git_info'
+
+# lolcommit test helpers
+require 'lolcommits/test_helpers/git_repo'
+require 'lolcommits/test_helpers/fake_io'
+
+if ENV['COVERAGE']
+  if ENV['TRAVIS']
+    require 'coveralls'
+    Coveralls.wear!
+  else
+    require 'simplecov'
+  end
+end
+
+# plugin gem test libs
+require 'lolcommits/twitter'
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+# swallow all debug output during test runs
+def debug(msg); end
+
+# do not launch URLs
+class Lolcommits::CLI::Launcher
+  def self.open_url(url);  end
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: lolcommits-twitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Hutchinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: simple_oauth
+  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: addressable
+  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: lolcommits
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: minitest
+  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: simplecov
+  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: coveralls
+  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: webmock
+  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: pry
+  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: Automatically tweet your lolcommits
+email:
+- matt@hiddenloop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lolcommits/plugin/twitter.rb
+- lib/lolcommits/twitter.rb
+- lib/lolcommits/twitter/client.rb
+- lib/lolcommits/twitter/version.rb
+- lolcommits-twitter.gemspec
+- test/lolcommits/plugin/twitter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/lolcommits/lolcommits-twitter
+licenses:
+- LGPL-3
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Post lolcommits to Twitter
+test_files:
+- test/lolcommits/plugin/twitter_test.rb
+- test/test_helper.rb