lolcommits-tumblr 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4408b248dddb5998fd1f34b8a33700cbd64fba8ab72a26a3eedc99065bd3661a
-  data.tar.gz: 6feb2dfc6960157600ec8b9e8b6430052bae9cc3f73012bac7ae2e651d414177
+  metadata.gz: f3a707d534f095ce7fab54dc773c1b8897dd75e2dcf58dfe700d2290f76d2377
+  data.tar.gz: cccfb490b45d0bc65a2eb2cc0b906cf55dee263f306ca732c5e11b4525f9c2d2
 SHA512:
-  metadata.gz: 1b33cd5e2a684e246a4596d87459e9b8ec649dd6f6f0bca46d5a3d8f16c0bfbe808d2a2d98fbff32cbca128ca8ec2df008db7822fb3cbf9e3e2db2b23236ab4d
-  data.tar.gz: c2c460ed764f94669c6335a9dda5333c074a1c1885c5dda7ec285f3e142ffe46d872c860fdf6fc7b26e90c224528c0e6fc4a000a4ffa923839bce9559e88b4cb
+  metadata.gz: e5d907e02eb2fdf7735b2e928441de5758fdaa922da75d0ba2803c6ffb39060850ceb54c502cd18e859a412905f2380ff06217a883252ae9904f990d7986672a
+  data.tar.gz: e039e75a37569b641b03481076e3e18e4bf9c6344685ba0f14aa2c165e2a4ebdbec93012e827ec5b5b2905a0bb958367267d0820798fa2f05e5d66f4e682d0d6

data/.travis.yml

@@ -2,10 +2,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
   - ruby-head
 
 before_install:

data/CHANGELOG.md

@@ -9,6 +9,10 @@ project adheres to [Semantic Versioning][Semver].
 
 - Your contribution here!
 
+## [0.5.1] - 2021-02-06
+## Added
+- Support for Ruby 3.0 (ditch tumblr_client gem, use faraday with simple_oauth)
+
 ## [0.5.0] - 2020-01-24
 ### Removed
 - Support for Ruby < 2.4 (older rubies no longer supported)
@@ -71,7 +75,8 @@ project adheres to [Semantic Versioning][Semver].
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/lolcommits/lolcommits-tumblr/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits-tumblr/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/lolcommits/lolcommits-tumblr/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/lolcommits/lolcommits-tumblr/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/lolcommits/lolcommits-tumblr/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/lolcommits/lolcommits-tumblr/compare/v0.3.0...v0.4.0

data/README.md

@@ -6,13 +6,12 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/0c289196d8504223c31a/maintainability)](https://codeclimate.com/github/lolcommits/lolcommits-tumblr/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/0c289196d8504223c31a/test_coverage)](https://codeclimate.com/github/lolcommits/lolcommits-tumblr/test_coverage)
 
-[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!
+[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 is a simple plugin to post lolcommits to your Tumblr. Configure it
-with a Tumblr access token and secret (the plugin will guide you through
-this process).
+This is a simple plugin to post lolcommits to your Tumblr. Configure it with a
+Tumblr access token and secret (the plugin will guide you through this process).
 
 ## Requirements
 
@@ -28,8 +27,8 @@ After installing the lolcommits gem, install this plugin with:
 
     $ gem install lolcommits-tumblr
 
-Then configure to enable. If this is your first time setting up, you'll
-be asked to visit Tumblr to authenticate and allow access.
+Then configure to enable. If this is your first time setting up, you'll be asked
+to visit Tumblr to authenticate and allow access.
 
     $ lolcommits --config -p tumblr
     # set enabled to `true`
@@ -38,16 +37,16 @@ be asked to visit Tumblr to authenticate and allow access.
     # optionally set a caption for each post (ERB friendly, see below)
     # optionally set the plugin to auto-open each created Tumblr post
 
-That's it! Your next lolcommit will automatically be posted to your
-Tumblr blog.  To disable use:
+That's it! Your next lolcommit will automatically be posted to your Tumblr blog.
+To disable use:
 
     $ lolcommits --config -p tumblr
     # and set enabled to `false`
 
 ### ERB friendly captions
 
-When configuring this plugin, you may optionally set a caption string to for
-each Tumblr post. The ERB bind has these variables available:
+You can optionally configure a caption string for each Tumblr post
+`caption_erb`. The ERB bind has these variables available:
 
 * `message` - commit message string
 * `sha` - commit sha (shortened)
@@ -55,25 +54,24 @@ each Tumblr post. The ERB bind has these variables available:
 * `repo` - vcs respository name
 * `vcs_info` - [vcs_info](https://github.com/lolcommits/lolcommits/blob/master/lib/lolcommits/vcs_info.rb) instance (from lolcommits)
 
-Allowing you to set caption strings like this:
+This allows you to set caption strings like this:
 
     Committed <%= sha %> in <%= repo %> on <%= branch %> - <%= message %>
 
 ## Development
 
-Check out this repo and run `bin/setup`, this will install all
-dependencies and generate docs. Use `bundle exec rake` to run all tests
-and generate a coverage report.
+Check out this repo and run `bin/setup`, this will install all dependencies and
+generate docs. Use `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.
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment with the gem code.
 
-This plugin uses the
-[tumblr-client](https://github.com/tumblr/tumblr_client) and
-[OAuth](https://rubygems.org/gems/oauth/versions/0.5.3) gems. A
+This plugin uses the [tumblr-client](https://github.com/tumblr/tumblr_client)
+and [OAuth](https://rubygems.org/gems/oauth/versions/0.5.3) gems. A
 [Webrick](https://rubygems.org/gems/webrick) server is started during
-configuration, to provide a responding `return_uri` for the OAuth flow
-to complete.
+configuration, to provide a responding `return_uri` for the OAuth flow to
+complete.
 
 ## Tests
 
@@ -90,27 +88,24 @@ Generate docs for this gem with:
 ## Troubles?
 
 If you think something is broken or missing, please raise a new
-[issue](https://github.com/lolcommits/lolcommits-tumblr/issues). Take a
-moment to check it hasn't been raised in the past (and possibly closed).
+[issue](https://github.com/lolcommits/lolcommits-tumblr/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-tumblr/issues)
-and [pull
-requests](https://github.com/lolcommits/lolcommits-tumblr/pulls) are
-welcome on GitHub.
+Bug [reports](https://github.com/lolcommits/lolcommits-tumblr/issues) and [pull
+requests](https://github.com/lolcommits/lolcommits-tumblr/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.com/lolcommits/lolcommits-tumblr). Read the
-[contributing
+When submitting pull requests, remember to add tests covering any new behaviour,
+and ensure all tests are passing on [Travis
+CI](https://travis-ci.com/lolcommits/lolcommits-tumblr). Read the [contributing
 guidelines](https://github.com/lolcommits/lolcommits-tumblr/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
+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-tumblr/blob/master/CODE_OF_CONDUCT.md)
 for more details.
 

data/lib/lolcommits/plugin/tumblr.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-require 'lolcommits/plugin/base'
-require 'lolcommits/cli/launcher'
-require 'oauth'
-require 'webrick'
-require 'cgi'
-require 'erb'
-require 'tumblr_client'
+require "lolcommits/plugin/base"
+require "lolcommits/cli/launcher"
+require "oauth"
+require "webrick"
+require "cgi"
+require "erb"
+require "faraday"
+require "faraday_middleware"
 
 module Lolcommits
   module Plugin
     class Tumblr < Base
 
-      TUMBLR_API_ENDPOINT    = 'https://www.tumblr.com'.freeze
-      TUMBLR_CONSUMER_KEY    = '2FtMEDpEPkxjoUdkpHh42h9wqTu9IVS7Ra0QyNZGixdCvhllN2'.freeze
-      TUMBLR_CONSUMER_SECRET = 'qWuvxgFUR2YyWKtbWOkDTMAiBEbj7ZGaNLaNQPba0PI1N4JpBs'.freeze
+      TUMBLR_API_HOST        = "api.tumblr.com".freeze
+      TUMBLR_API_ENDPOINT    = "https://www.tumblr.com".freeze
+      TUMBLR_CONSUMER_KEY    = "2FtMEDpEPkxjoUdkpHh42h9wqTu9IVS7Ra0QyNZGixdCvhllN2".freeze
+      TUMBLR_CONSUMER_SECRET = "qWuvxgFUR2YyWKtbWOkDTMAiBEbj7ZGaNLaNQPba0PI1N4JpBs".freeze
 
       ##
       # Post-capture hook, runs after lolcommits captures a snapshot.
@@ -24,23 +26,28 @@ module Lolcommits
       #
       def run_capture_ready
         if runner.capture_video && !runner.capture_gif
-          debug "unable to post lolcommit videos, (gif's and jpgs only)"
+          debug "unable to post videos, (Tumblr API only supports images)"
           return
         end
 
         print "*** Posting to Tumblr ... "
-        post = client.photo(
-          configuration[:tumblr_name],
-          data: image_path,
-          caption: tumblr_caption
-        )
+        response = tumblr_api.post do |req|
+          req.url "v2/blog/#{configuration[:tumblr_name]}/post"
+          req.body = {
+            caption: tumblr_caption,
+            type: "photo",
+            data: Faraday::FilePart.new(lolcommit_path, lolcommit_mime_type)
+          }
+        end
+
+        post = response.body["response"] || {}
 
         if post.key?('id')
           post_url = tumblr_post_url(post)
           open_url(post_url) if configuration[:open_url]
           print "done! #{post_url}\n"
         else
-          print "Post FAILED! #{post.inspect}"
+          print "Post FAILED! #{response.inspect}"
         end
       rescue Faraday::Error => e
         print "Post FAILED! #{e.message}"
@@ -80,15 +87,47 @@ module Lolcommits
 
       private
 
-      def image_path
+      def lolcommit_path
         runner.capture_image? ? runner.lolcommit_path : runner.lolcommit_gif_path
       end
 
+      def lolcommit_mime_type
+        runner.capture_image? ?  "image/jpeg" : "image/gif"
+      end
+
+      def tumblr_api
+        # TODO: maybe remove faraday, just use Net::HTTP and simpler code for
+        # Oauth1.0 auth (so we can remove a few runtime deps)
+        @tumblr_api ||= Faraday.new(url: "https://#{TUMBLR_API_HOST}/", headers: api_headers) do |conn|
+          conn.request :oauth, api_oauth
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.response :json, :content_type => /\bjson$/
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def api_headers
+        {
+          accept: "application/json",
+          user_agent: "lolcommits-tumblr/#{Lolcommits::Tumblr::VERSION}"
+        }
+      end
+
+      def api_oauth
+        {
+          consumer_key: TUMBLR_CONSUMER_KEY,
+          consumer_secret: TUMBLR_CONSUMER_SECRET,
+          token: configuration[:access_token],
+          token_secret: configuration[:secret]
+        }
+      end
+
       def configure_auth!
-        puts ''
-        puts '----------------------------------------'
-        puts '    Need to grab Tumblr Oauth token     '
-        puts '----------------------------------------'
+        puts ""
+        puts "----------------------------------------"
+        puts "    Need to grab Tumblr Oauth token     "
+        puts "----------------------------------------"
 
         request_token = oauth_consumer.get_request_token(exclude_callback: true)
         puts "\nOpening this url to authorize lolcommits:"
@@ -96,9 +135,9 @@ module Lolcommits
         open_url(request_token.authorize_url)
         puts "\nLaunching local webbrick server to complete the OAuth process ...\n"
         begin
-          trap('INT') { local_server.shutdown }
-          trap('SIGTERM') { local_server.shutdown }
-          local_server.mount_proc '/', server_callback
+          trap("INT") { local_server.shutdown }
+          trap("SIGTERM") { local_server.shutdown }
+          local_server.mount_proc "/", server_callback
           local_server.start
           debug "Requesting Tumblr OAuth Token with verifier: #{@verifier}"
           access_token = request_token.get_access_token(oauth_verifier: @verifier)
@@ -111,10 +150,10 @@ module Lolcommits
         end
         return unless access_token.token && access_token.secret
 
-        puts ''
-        puts '----------------------------------------'
-        puts 'Thanks! Lolcommits Tumblr Auth Succeeded'
-        puts '----------------------------------------'
+        puts ""
+        puts "----------------------------------------"
+        puts "Thanks! Lolcommits Tumblr Auth Succeeded"
+        puts "----------------------------------------"
 
         {
           access_token: access_token.token,
@@ -133,15 +172,6 @@ module Lolcommits
         { tumblr_name: tumblr_name, open_url: open_url, caption_erb: caption_erb }
       end
 
-      def client
-        @client ||= ::Tumblr.new(
-          consumer_key: TUMBLR_CONSUMER_KEY,
-          consumer_secret: TUMBLR_CONSUMER_SECRET,
-          oauth_token: configuration[:access_token],
-          oauth_token_secret: configuration[:secret]
-        )
-      end
-
       def oauth_consumer
         @oauth_consumer ||= OAuth::Consumer.new(
           TUMBLR_CONSUMER_KEY,
@@ -159,7 +189,7 @@ module Lolcommits
       end
 
       def tumblr_post_url(post)
-        "https://#{configuration[:tumblr_name]}.tumblr.com/post/#{post['id']}"
+        "https://#{configuration[:tumblr_name]}.tumblr.com/post/#{post["id"]}"
       end
 
       def tumblr_caption
@@ -247,8 +277,8 @@ module Lolcommits
           query = req.request_uri.query
           query = CGI.parse(req.request_uri.query) if query
 
-          if query && query['oauth_verifier']
-            @verifier = query['oauth_verifier'][0]
+          if query && query["oauth_verifier"]
+            @verifier = query["oauth_verifier"][0]
             res.body = oauth_response(
               "Lolcommits Authorization Complete",
               "Please return to your console to complete the <a href=\"https://github.com/lolcommits/lolcommits-tumblr\">lolcommits-tumblr</a> plugin setup"

data/lib/lolcommits/tumblr/version.rb

@@ -2,6 +2,6 @@
 
 module Lolcommits
   module Tumblr
-    VERSION = "0.5.0".freeze
+    VERSION = "0.5.1".freeze
   end
 end

data/lolcommits-tumblr.gemspec

@@ -1,6 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lolcommits/tumblr/version'
+require "lolcommits/tumblr/version"
 
 Gem::Specification.new do |spec|
   spec.name     = "lolcommits-tumblr"
@@ -32,10 +32,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.4"
 
-  spec.add_runtime_dependency('tumblr_client')
-  spec.add_runtime_dependency('webrick')
-  spec.add_runtime_dependency('oauth')
   spec.add_runtime_dependency "lolcommits", ">= 0.14.2"
+  spec.add_runtime_dependency("faraday")
+  spec.add_runtime_dependency("faraday_middleware")
+  spec.add_runtime_dependency("simple_oauth")
+  spec.add_runtime_dependency("oauth")
+  spec.add_runtime_dependency("webrick")
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "webmock"

data/test/lolcommits/plugin/tumblr_test.rb

@@ -51,7 +51,7 @@ describe Lolcommits::Plugin::Tumblr do
         in_repo do
           plugin.configuration = valid_enabled_config
 
-          stub_request(:post, "https://api.tumblr.com/v2/blog/my-tumblr.tumblr.com/post").to_return(
+          stub_request(:post, "https://api.tumblr.com/v2/blog/my-tumblr/post").to_return(
             body: {
               "meta" => { "status" => 201, "msg" => "Created"},
               "response" => { "id" => 123456789 }
@@ -63,7 +63,7 @@ describe Lolcommits::Plugin::Tumblr do
           output = fake_io_capture { plugin.run_capture_ready }
           _(output).must_match "done! https://my-tumblr.tumblr.com/post/123456789"
 
-          assert_requested :post, "https://api.tumblr.com/v2/blog/my-tumblr.tumblr.com/post", times: 1,
+          assert_requested :post, "https://api.tumblr.com/v2/blog/my-tumblr/post", times: 1,
             headers: { "Content-Type" => /multipart\/form-data/, "Accept" => "application/json" } do |req|
             _(req.body).must_match 'filename="lolcommit.jpg'
           end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-tumblr
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Matthew Hutchinson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: tumblr_client
+  name: lolcommits
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: faraday_middleware
+  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:
     - - ">="
@@ -53,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lolcommits
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +215,7 @@ metadata:
   source_code_uri: https://github.com/lolcommits/lolcommits-tumblr
   bug_tracker_uri: https://github.com/lolcommits/lolcommits-tumblr/issues
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,8 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Post lolcommits to Tumblr
 test_files: