qiita-export 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 821a3351e6e0d5ae3a620e12828d645e9b985678
-  data.tar.gz: 18d4e090f2d8f10f06e81344d9f13772cdace11c
+  metadata.gz: 07a761de535b3fac30e81ce02879ccecad548aaa
+  data.tar.gz: f7e388a44e4e543b30beca43b30b2d73d125999f
 SHA512:
-  metadata.gz: 1551e1b916754310037f0993f8ed1048bd27fdd11f7eb5b57e209e68799ea30e5a509d69846183eae8ea7105703309814a9c869742ce138013ef24245addd994
-  data.tar.gz: acf2bea60094739fdc10959eaf703ddcf27381fd587de0db4900de29482b008a169188fdf9415908c2e8fe1646d2b55dba358145efd5a3c586fe5b0e72bff865
+  metadata.gz: 55c498a11247a4179ecf9987af52a046327931449471a160bedeab72deff77c43d5ea0d93159e1ab6ed9e08989f9fdbb0283561520a08a1c05090a14e8c85076
+  data.tar.gz: 09558c17f085b0d3ea750728bd6ca1f807dc6adc01fe594681cbc89cdb76c2d6a6d28e54bf048867bc2298493f205a26f68761ed46fe3a7e4ee34e58951f9445

data/README.md

@@ -2,6 +2,9 @@
 
 export tool for Qiita(http://qiita.com/).
 
+qiita-export | RubyGems.org  
+https://rubygems.org/gems/qiita-export/
+
 ## Installation
 
 Add this line to your Gemfile:
@@ -33,6 +36,7 @@ Usage: qiita-export [options]
     -t, --team=teamname              export Qiita Team articles only.
     -T, --team-all                   export Qiita Team all articles.
     -i, --image                      export with images.
+    -c, --comment                    export with comments.
     -h, --html                       export in html format(experimental).
     -o, --output-dir=dirpath         specify the full path of destination directory.
     -a, --api-token=token            specify API token for Qiita.

data/lib/qiita-export.rb

@@ -1,5 +1,6 @@
 require 'qiita-export/version'
 require 'qiita-export/image'
+require 'qiita-export/comment'
 require 'qiita-export/article'
 require 'qiita-export/config'
 require 'qiita-export/exporter'

data/lib/qiita-export/article.rb

@@ -33,15 +33,20 @@ module QiitaExport
     end
 
     def save
-      save_dir  = File.join(Config.export_dir_path, Config.team_name(@url), @key)
+      save_dir  = File.join(Config.export_dir_path(@url), @key)
 
       FileUtils.makedirs(save_dir) unless Dir.exists?(save_dir)
 
       file_path = File.join(save_dir, Config.filename(title))
       File.open(file_path, "w") { |f| f.write export_content }
-      if (Config.image_export?)
+
+      if Config.image_export?
         @images.each { |image| image.save(save_dir) }
       end
+
+      if Config.comment_export?
+        Comment.new(@url).save(save_dir)
+      end
     end
 
     private

data/lib/qiita-export/comment.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require 'fileutils'
+require 'uri'
+
+module QiitaExport
+  class Comment
+    attr_reader :key
+
+    def initialize(url)
+      @endpoint = Fetcher::ApiEndPoint.instance(:comment)
+      @url = url
+    end
+
+    def request_header
+      Config.has_api_token? ? Config.auth_header : Config.default_header
+    end
+
+    def filename
+      "comments.json"
+    end
+
+    def save(path)
+      comments = find_comments
+      return if comments =~ /^\[\]$/i
+
+      file_path = File.join(File.expand_path(path), filename)
+      open(file_path, 'wb') do |out|
+        out.write(comments)
+      end
+    end
+
+    def find_comments
+      url = @endpoint.url(article_url: @url)
+      open(url, request_header) do |io|
+        io.read
+      end
+    rescue => e
+      $stderr.puts "#{e} : #{url}"
+      raise
+    end
+  end
+end

data/lib/qiita-export/config.rb

@@ -27,6 +27,7 @@ module QiitaExport
           opt.on('-t', '--team=teamname',          'export Qiita Team articles only.')                     { |v| @option[:team] = v }
           opt.on('-T', '--team-all',               'export Qiita Team all articles.')                      { |v| @option[:'team-all'] = v }
           opt.on('-i', '--image',                  'export with images.')                                  { |v| @option[:image] = v }
+          opt.on('-c', '--comment',                'export with comments.')                                { |v| @option[:comment] = v }
           opt.on('-h', '--html',                   'export in html format(experimental).')                 { |v| @option[:html] = v }
           opt.on('-o', '--output-dir=dirpath',     'specify the full path of destination directory.')      { |v| @option[:'output-dir'] = v }
           opt.on('-a', '--api-token=token',        'specify API token for Qiita.')                         { |v| @option[:'api-token'] = v }
@@ -111,6 +112,10 @@ module QiitaExport
         @option[:image]
       end
 
+      def comment_export?
+        @option[:comment]
+      end
+
       def team_url?(url)
         url !~ /^https?:\/\/qiita\.com/
       end
@@ -126,6 +131,19 @@ module QiitaExport
         end
       end
 
+      USER_ID_PATTERN = Regexp.new("https?://[^/?&#]+/([^/]+)/")
+      def user_id(url = nil)
+        if url.nil?
+          @option[:'user-id']
+        else
+          url.match(USER_ID_PATTERN)[1]
+        end
+      end
+
+      def article_key(url)
+        File.basename(url)
+      end
+
       def article_urls
         urls = []
         urls << @option[:url] if present?(@option[:url])
@@ -180,16 +198,15 @@ module QiitaExport
         header
       end
 
-      def user_id
-        @option[:'user-id']
+      def output_dir
+        return "" unless file_export?
+        File.expand_path(@option[:'output-dir'].strip)
       end
 
-      def export_dir_path
-        if user?
-          File.join(File.expand_path(@option[:'output-dir'].strip), user_id)
-        else
-          File.expand_path(@option[:'output-dir'].strip)
-        end
+      def export_dir_path(url)
+        team = team_name(url)
+        user = user_id(url)
+        File.join(output_dir, team, user)
       end
 
       def filename(title)

data/lib/qiita-export/exporter.rb

@@ -37,8 +37,13 @@ module QiitaExport
     end
 
     def export_file(articles)
-      $stdout.puts "export articles to #{Config.export_dir_path}"
-      FileUtils.makedirs(Config.export_dir_path) unless Dir.exists?(Config.export_dir_path)
+      if articles.length < 1
+        $stdout.puts("no articles found.")
+        return
+      end
+
+      $stdout.puts "export articles to #{Config.output_dir}"
+
       articles.each do |article|
         article.save
       end

data/lib/qiita-export/fetcher/api_end_point.rb

@@ -3,16 +3,22 @@
 module QiitaExport::Fetcher
   class ApiEndPoint
 
+    MAX_PER_PAGE = 100
+
     def initialize
       @config = ::QiitaExport::Config
     end
 
-    def next_page(page)
+    def url(article_url: nil, page: 1)
       raise NotImplementedError.new("You must implement #{self.class}##{__method__}")
     end
 
     def self.instance(end_point_sym)
       case end_point_sym
+      when :item
+        ItemEndPoint.new
+      when :comment
+        CommentEndPoint.new
       when :user
         UserEndPoint.new
       when :team
@@ -23,19 +29,27 @@ module QiitaExport::Fetcher
     end
   end
 
-  class UserEndPoint < ApiEndPoint
-    PER_PAGE = 100
+  class ItemEndPoint < ApiEndPoint
+    def url(article_url: nil, page: 1)
+      "https://#{@config.api_domain(article_url)}/api/v2/items/#{@config.article_key(article_url)}"
+    end
+  end
 
-    def next_page(page)
-      "https://#{@config.api_domain}/api/v2/users/#{@config.user_id}/items?page=#{page}&per_page=#{PER_PAGE}"
+  class CommentEndPoint < ApiEndPoint
+    def url(article_url: nil, page: 1)
+      "https://#{@config.api_domain(article_url)}/api/v2/items/#{@config.article_key(article_url)}/comments"
     end
   end
 
-  class TeamEndPoint < ApiEndPoint
-    PER_PAGE = 100
+  class UserEndPoint < ApiEndPoint
+    def url(article_url: nil, page: 1)
+      "https://#{@config.api_domain}/api/v2/users/#{@config.user_id}/items?page=#{page}&per_page=#{MAX_PER_PAGE}"
+    end
+  end
 
-    def next_page(page)
-      "https://#{@config.api_domain}/api/v2/items?page=#{page}&per_page=#{PER_PAGE}"
+  class TeamEndPoint < ApiEndPoint
+    def url(article_url: nil, page: 1)
+      "https://#{@config.api_domain}/api/v2/items?page=#{page}&per_page=#{MAX_PER_PAGE}"
     end
   end
 end

data/lib/qiita-export/fetcher/api_fetcher.rb

@@ -20,10 +20,6 @@ module QiitaExport::Fetcher
       ::QiitaExport::Article.new(key, url, title, raw_body, rendered_body, created_at, updated_at, user_id)
     end
 
-    def article_key(url)
-      File.basename(url)
-    end
-
     def request_header
       has_api_token? ? auth_header : default_header
     end

data/lib/qiita-export/fetcher/base.rb

@@ -9,7 +9,7 @@ module QiitaExport::Fetcher
                              :export_dir_path, :team?, :team_name,
                              :article_urls, :has_api_token?, :api_token,
                              :user_id, :default_header, :auth_header,
-                             :api_domain
+                             :api_domain, :article_key
 
     def initialize
       @config = ::QiitaExport::Config

data/lib/qiita-export/fetcher/kobito_fetcher.rb

@@ -54,7 +54,7 @@ module QiitaExport::Fetcher
     private
 
     def to_article(row)
-      key           = File.basename(row['ZURL'])
+      key           = article_key(row['ZURL'])
       url           = row['ZURL']
       title         = row['ZTITLE']
       raw_body      = row['ZRAW_BODY']

data/lib/qiita-export/fetcher/pagination_fetcher.rb

@@ -5,8 +5,6 @@ require 'open-uri'
 module QiitaExport::Fetcher
   class PaginationFetcher < ApiFetcher
 
-    PER_PAGE = 100
-
     def initialize(endpoint_sym)
       super()
       @endpoint = ApiEndPoint.instance(endpoint_sym)
@@ -33,8 +31,8 @@ module QiitaExport::Fetcher
     private
 
     def paginate_articles(page)
-      url = @endpoint.next_page(page)
-      open(@endpoint.next_page(page), request_header) do |io|
+      url = @endpoint.url(page: page)
+      open(url, request_header) do |io|
         JSON.parse(io.read)
       end
     rescue => e

data/lib/qiita-export/fetcher/url_fetcher.rb

@@ -5,6 +5,11 @@ require 'open-uri'
 module QiitaExport::Fetcher
   class UrlFetcher < ApiFetcher
 
+    def initialize
+      super()
+      @endpoint = ApiEndPoint.instance(:item)
+    end
+
     def find_articles
       articles = []
       article_urls.each do |url|
@@ -16,10 +21,14 @@ module QiitaExport::Fetcher
 
     private
 
-    def find_article(url)
-      open("https://#{api_domain(url)}/api/v2/items/#{article_key(url)}", request_header) do |io|
+    def find_article(article_url)
+      url = @endpoint.url(article_url: article_url)
+      open(url, request_header) do |io|
         JSON.parse(io.read)
       end
+    rescue => e
+      $stderr.puts "#{e} : #{url}"
+      raise
     end
   end
 end

data/lib/qiita-export/version.rb

@@ -1,4 +1,4 @@
 module QiitaExport
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end
 

data/qiita-export.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.bindir        = 'bin'
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_dependency "sqlite3"
 
   spec.add_development_dependency "bundler", "~> 1.7"

data/spec/qiita-export/config_spec.rb

@@ -5,6 +5,7 @@ require 'qiita-export'
 
 describe QiitaExport::Config do
   let(:valid_url)       { 'http://qiita.com/akishin/items/61630d628f4c8e141ef2' }
+  let(:valid_team_url)  { 'http://example.qiita.com/foo@github/items/99999999999999999999' }
   let(:valid_kobito_db) { File.expand_path(QiitaExport::Config::DEFAULT_KOBITO_DB) }
   let(:valid_team_name) { 'example' }
   let(:valid_argv) {
@@ -42,6 +43,33 @@ describe QiitaExport::Config do
 
   end
 
+  describe ".user_id" do
+    context "with user_id option" do
+      subject do
+        described_class.configure(['--user-id', 'foo'])
+      end
+      it { expect(subject.user_id).to eq('foo') }
+    end
+
+    context "without user_id option" do
+      subject do
+        described_class.configure(valid_argv)
+      end
+      it { expect(subject.user_id).to be_nil }
+      it { expect(subject.user_id(valid_url)).to eq('akishin') }
+      it { expect(subject.user_id(valid_team_url)).to eq('foo@github') }
+    end
+  end
+
+  describe ".export_dir_path" do
+    subject do
+      described_class.configure(['--output-dir', '/tmp/output'])
+    end
+
+    it { expect(subject.export_dir_path(valid_url)).to eq('/tmp/output/qiita/akishin') }
+    it { expect(subject.export_dir_path(valid_team_url)).to eq('/tmp/output/example/foo@github') }
+  end
+
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-export
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shin Akiyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -82,6 +82,7 @@ files:
 - bin/qiita-export
 - lib/qiita-export.rb
 - lib/qiita-export/article.rb
+- lib/qiita-export/comment.rb
 - lib/qiita-export/config.rb
 - lib/qiita-export/exporter.rb
 - lib/qiita-export/fetcher/api_end_point.rb
@@ -108,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="