middleman-medium_export 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70a0f8d944340107139756124aa63973a3f71c686fcee927ea63a830e8971f22
+  data.tar.gz: 8cca4d27765a84ffaedb871012d3f46fe1b2ec33f4d8874155a6c4a593829c17
+SHA512:
+  metadata.gz: c6884c14ae7550558aa91a0ce8d80d548f1a37c5305b6d291ccae6910cc79a7ece792218b36cdd3a730d1f419163edf0f9743a3930997a95134947c1c6b64570
+  data.tar.gz: 7178bd55aab8c1524da4464caf0a91189f3a50eaa9044b0a922050536959afeafe2e1a30757850199ee7c53605c48b3ab16cac75bc136005eb762e1767382a8d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 John Nunemaker
+
+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/README.md

@@ -0,0 +1,77 @@
+# Middleman Medium Export
+
+A Middleman extension that adds a cli command to export your articles to medium
+
+# Getting Started
+
+Add the gem to your gemfile
+
+```ruby
+gem "middleman-medium_export"
+```
+
+Activate it in your `config.rb`
+
+```ruby
+activate :medium_export do |export|
+  export.api_token = 'your_api_token'
+
+  # export.template_path = 'path_to_template'
+  # export.template_position = :top
+  # export.publish_status = :draft
+end
+```
+
+## Options
+
+Extension provides several options
+
+`api_token` - required, self issued api token to post your articles
+
+`template_path` - optinal, path to partial to add to your article
+`template_position` - optional. Position of your template. Possible values are: `:top` and `:bottom`. Default is `:bottom`
+`publish_status` - optional. Status of your articles, when they are exported. Possible values are: `public`, `draft`, or `unlisted`. Default is `:draft`
+
+## Export
+
+### Interactivly
+
+To chose article to export interactivlt
+
+```ruby
+be middleman medium_export -m interactive
+```
+
+### Only last article
+
+```ruby
+be middleman medium_export
+```
+
+or 
+
+```ruby
+be middleman medium_export -m last
+```
+
+### All articles
+
+```ruby
+be middleman medium_export -m all
+```
+
+## Obtaining Api Token
+
+You used to be able to create an `api_token` yourself, but due to increased spam activity from API, this feature is now restricted. You need to email support with request for an API Token. It usually takes from a couple of hours to a day. Visit official [documentaion](https://github.com/Medium/medium-api-docs#22-self-issued-access-tokens) for more info.
+
+# Contribution
+
+Pull requests and issues are very welcome
+
+To create a pull request
+
+* Clone repo
+* Run tests to see, that all is fine `be rake test`
+* Implement feature
+* Add tests
+

data/lib/middleman-medium_export.rb

@@ -0,0 +1,8 @@
+require "middleman-core"
+
+Middleman::Extensions.register :medium_export do
+  require "middleman-medium_export/extension"
+  require "middleman-medium_export/commands/export"
+
+  MediumExport
+end

data/lib/middleman-medium_export/api_client.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+
+class MediumExport::ApiClient
+  include HTTParty
+
+  attr_reader :auth, :publish_status
+
+  base_uri 'https://api.medium.com/v1/'
+
+  headers 'Content-Type': 'application/json'
+  headers 'Accept': 'application/json'
+
+  # raise_on (400..599).to_a
+
+  def initialize(api_token:, publish_status:)
+    @auth = { Authorization: "Bearer #{api_token}" }
+    @publish_status = publish_status
+  end
+
+  def publish(content:, title:, tags:)
+    response = self.class.post(
+      "/users/#{id}/posts",
+      headers: auth,
+      body: {
+        "title": title,
+        "contentFormat": "html",
+        "content": content,
+        "tags": tags,
+        "publishStatus": publish_status
+      }.to_json
+    )
+  end
+
+  def upload_image(image:)
+    response = self.class.post(
+      "https://api.medium.com/v1/images",
+      headers: auth,
+      body: {
+        "image": image
+      }
+    )
+  end
+
+  def me
+    self.class.get('/me', headers: auth)
+  end
+
+  private
+
+  def id
+    @id ||= me['data']['id']
+  end
+end

data/lib/middleman-medium_export/articles_filter.rb

@@ -0,0 +1,36 @@
+class MediumExport::ArticlesFilter
+  attr_reader :articles, :shell
+
+  def initialize(articles:, shell:)
+    @articles = articles
+    @shell = shell
+  end
+
+  def last
+    [articles.first]
+  end
+
+  def all
+    articles
+  end
+
+  def interactive
+    articles.each_with_object([]) do |article, acc|
+      case ask_to_include(article.title)
+        when 'Y' then acc.push(article)
+        when 'S' then acc.push(article) and break(acc)
+        when 'Q' then break(acc)
+      end
+    end
+  end
+
+  private
+
+  def ask_to_include(title)
+    shell.say(%Q(Do you want to publish "#{title}"\n).freeze)
+    shell.say("  Y - yes and continue\n  S - yes and quit".freeze, :green)
+    shell.say("  N - no and continue\n  Q - no and quit\n".freeze, :red)
+
+    shell.ask("\n ", :magenta, limited_to: %w(Y S N Q).freeze)
+  end
+end

data/lib/middleman-medium_export/commands/export.rb

@@ -0,0 +1,74 @@
+require 'middleman-core/cli'
+require 'middleman-blog/uri_templates'
+require 'middleman-medium_export/articles_filter'
+require 'middleman-medium_export/content'
+require 'middleman-medium_export/publisher'
+
+module Middleman
+
+  module Cli
+
+    ##
+    # This class provides an "medium_export" command for the middleman CLI.
+    #
+    # @usage bundle exec middleman medium_export
+    # @usage bundle exec middleman medium_export --help
+    # @usage bundle exec middleman medium_export --mode last
+    # @usage bundle exec middleman medium_export --mode interactive
+    #
+    ##
+    class Export < ::Thor::Group
+      include Thor::Actions
+      include Blog::UriTemplates
+
+      check_unknown_options!
+
+      class_option "blog",
+        aliases: "-b",
+        desc:    "The name of the blog to create the post inside (for multi-blog apps, defaults to the only blog in single-blog apps)"
+
+      class_option "mode",
+        aliases: "-m",
+        enum: %w[last all interactive],
+        default: 'last',
+        desc: "Chose which articles should be published"
+
+
+      def medium_export
+        articles = blog.data.articles.sort_by { |a| -a.date.to_i }
+
+        filtered_articles = MediumExport::ArticlesFilter.
+          new(articles: articles, shell: shell).
+          public_send(options.mode)
+
+        content = filtered_articles.map do |article|
+          MediumExport::Content.new(article: article, template: export_extension.template)
+        end
+
+        MediumExport::Publisher.new(
+          api_client: export_extension.api_client, content: content, shell: shell).call
+      end
+
+      private
+
+      def export_extension
+        @export_extension ||= app.extensions[:medium_export]
+      end
+
+      def app
+        @app ||= ::Middleman::Application.new
+      end
+
+      def blog
+        @blog ||= if options[:blog]
+          app.extensions[:blog].find { | k, v | v.options[:name] == options[ :blog ] }.last
+        else
+          app.extensions[:blog].values.first
+        end
+      end
+
+      # Add to CLI
+      Base.register(self, 'medium_export', 'medium_export [options]', 'Export one or more articles to middleman')
+    end
+  end
+end

data/lib/middleman-medium_export/content.rb

@@ -0,0 +1,58 @@
+require 'nokogiri'
+
+class MediumExport::Content
+  Image = Struct.new(:src, :location)
+
+  attr_reader :article, :template
+
+  def initialize(article:, template: nil)
+    @article = article
+    @template = template
+  end
+
+  def html
+    @content ||= begin
+      template ? body_with_template : article.body
+    end
+  end
+
+  def markdown
+    @markdown ||= File.read(article.source_file)
+  end
+
+  def title
+    article.title
+  end
+
+  def tags
+    article.tags
+  end
+
+  def local_images
+    @images ||= Nokogiri::HTML(html).search('img').map do |img|
+      src = img.attributes['src'].value
+      next if src.start_with?('http')
+
+      Image.new(src, File.join(source_dir, src))
+    end.compact
+  end
+
+  private
+
+  def body_with_template
+    template_html = template_context.render(nil, template.path, { locals: {}})
+    template.position == :top ? "#{template_html}#{article.body}" : "#{article.body}#{template_html}"
+  end
+
+  def source_dir
+    @source_dir ||= app.source_dir
+  end
+
+  def template_context
+    @template_context ||= app.generic_template_context
+  end
+
+  def app
+    @app ||= article.blog_data.controller.app
+  end
+end

data/lib/middleman-medium_export/extension.rb

@@ -0,0 +1,66 @@
+# Require core library
+require 'middleman-core'
+
+# Extension namespace
+class MediumExport < ::Middleman::Extension
+  require 'middleman-medium_export/api_client'
+  require 'middleman-medium_export/template'
+
+  ApiTokenMissing = Class.new(ArgumentError)
+  InvalidTemplatePosition = Class.new(ArgumentError)
+  InvalidPublishStatus = Class.new(ArgumentError)
+
+  TEMPLATES_POSSITIONS = %w[bottom top].freeze
+  PUBLISH_STATUSES = %i[public draft unlisted].freeze
+
+  option :api_token, nil, 'Medium API Token'
+  option :template_path, nil, 'HTML template to append to the end of each article'
+  option :template_position, :bottom
+  option :publish_status, :draft
+  option :tags_field, :tags
+
+  def initialize(app, options_hash={}, &block)
+    super
+
+    check_api_token!
+    check_template_positions!
+    check_publish_statuses!
+  end
+
+  def api_client
+    @api_client ||= ApiClient.new(options.to_h.slice(:api_token, :publish_status))
+  end
+
+  def template
+    return unless options.template_path
+
+    Template.new(options.to_h.slice(:template_path, :template_position))
+  end
+
+  private
+
+  def check_api_token!
+    return unless options.api_token.to_s.empty?
+
+    error_msg = "Please, provide an api_token option. To obtain api_token refer to\n" \
+      "https://help.medium.com/hc/en-us/articles/213480228-Get-integration-token\n\n"
+    raise ApiTokenMissing, error_msg
+  end
+
+  def check_template_positions!
+    position = options.template_position.to_s
+    return if position.empty? || TEMPLATES_POSSITIONS.include?(position)
+
+    error_msg = "Invalid template_position: #{options.template_position}.\n" \
+      "Possible template positions are: #{TEMPLATES_POSSITIONS.join(", ")}\n\n"
+    raise InvalidTemplatePosition, error_msg
+  end
+
+  def check_publish_statuses!
+    return if PUBLISH_STATUSES.include?(options.publish_status.to_sym)
+
+    error_msg = "Invalid publish_status: #{options.publish_status}.\n" \
+      "Possible publish statuses are: #{PUBLISH_STATUSES.join(", ")}\n\n"
+    raise InvalidPublishStatus, error_msg
+  end
+end

data/lib/middleman-medium_export/publisher.rb

@@ -0,0 +1,30 @@
+class MediumExport::Publisher
+  attr_reader :content, :shell, :api_client
+
+  def initialize(content:, shell:, api_client:)
+    @content = content
+    @shell = shell
+    @api_client = api_client
+  end
+
+  def call
+    shell.say("Preparing to publish #{content.size} articles") if content.size > 1
+
+    content.each do |article|
+      publish(article)
+      shell.say(%Q(Published: "#{article.title}"), :green)
+    end
+  end
+
+  private
+
+  def publish(article)
+    updated_html = article.local_images.inject(article.html) do |html, image|
+      response = api_client.upload_image(image: File.open(image.location))
+      url = response['data']['url'] # it may contain errors  {"errors"=>[{"message"=>"Token was invalid.", "code"=>6003}]}
+      html.gsub(image.src, url)
+    end
+
+    api_client.publish(content: updated_html, tags: article.tags, title: article.title)
+  end
+end

data/lib/middleman-medium_export/template.rb

@@ -0,0 +1,9 @@
+class MediumExport::Template
+
+  attr_reader :path, :position
+
+  def initialize(template_path:, template_position:)
+    @path = template_path
+    @position = template_position.to_sym
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: middleman-medium_export
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- TheSmartnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: middleman-blog
+  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: nokogiri
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+- !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'
+- !ruby/object:Gem::Dependency
+  name: middleman-cli
+  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: |
+  An extension to export your articles created with
+  middleman-blog to medium from a command line.
+email:
+- misharinn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/middleman-medium_export.rb
+- lib/middleman-medium_export/api_client.rb
+- lib/middleman-medium_export/articles_filter.rb
+- lib/middleman-medium_export/commands/export.rb
+- lib/middleman-medium_export/content.rb
+- lib/middleman-medium_export/extension.rb
+- lib/middleman-medium_export/publisher.rb
+- lib/middleman-medium_export/template.rb
+homepage: https://github.com/TheSmartnik/middleman-medium_export
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A Middleman extension to export your blogposts to medium
+test_files: []