rmwiki 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0729913a338313c2d4290cc8db08930c5c13c2e
+  data.tar.gz: fa73337b194bb00d5640e42aadf8e01edbae7e17
+SHA512:
+  metadata.gz: 1b78cbed07fca24eae191903486aaf4b7ad8d2143aa8c617fb11869ebc5ea150d0f3a04a86ea9664c5fe17be8b6b9600b0d39e509f7120c7224cd1ceab45ed93
+  data.tar.gz: 8b1fd543f8ad24dbeabcb4de1960cdf713959590c129e394f10f8f117c5bc1452a7ba036cfd7679c870bfc2378974ec55f6c9a91d17fe23e48693f0476663351

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rmwiki.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bigwheel
+
+MIT License
+
+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,31 @@
+# Rmwiki
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rmwiki'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rmwiki
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rmwiki/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/rmwiki.rb

@@ -0,0 +1,134 @@
+require 'httpclient'
+require 'nokogiri'
+require 'json'
+require 'uri'
+require 'time'
+
+class Rmwiki
+  # ここで使われたユーザーはRedMineの方の操作ログに名前が残るよ
+  def initialize(wiki_root, username, password)
+    @wiki_root = wiki_root
+    @http_client = HTTPClient.new
+    login username, password
+  end
+
+  class SimpleWikiPage
+    attr_reader :title, :parent_title, :version, :created_on, :updated_on
+
+    def initialize(raw_obj)
+      @title        = raw_obj['title']
+      @parent_title = raw_obj['parent'] && raw_obj['parent']['title']
+      # Option型ってないんよね
+      @version      = raw_obj['version']
+      @created_on   = DateTime::iso8601(raw_obj['created_on'])
+      @updated_on   = DateTime::iso8601(raw_obj['updated_on'])
+    end
+  end
+
+  class ExtendedWikiPage < SimpleWikiPage
+    attr_reader :text, :author_id, :author_name, :comments
+    def initialize(raw_obj)
+      super(raw_obj)
+      @text        = raw_obj['text']
+      @author_id   = raw_obj['author']['id']
+      @author_name = raw_obj['author']['name']
+      @comments    = raw_obj['comments']
+    end
+  end
+
+  def all_pages
+    response = @http_client.get(File.join(@wiki_root, 'index.json'))
+    check_status_code response
+    JSON.parse(response.content)['wiki_pages'].map { |raw_obj|
+      SimpleWikiPage.new(raw_obj)
+    }
+  end
+
+  def page page_title
+    response = @http_client.get(File.join(@wiki_root, URI::escape(page_title) + '.json'))
+
+    if response.header.status_code == 200
+      ExtendedWikiPage.new(JSON.parse(response.content)['wiki_page'])
+    else
+      nil
+    end
+  end
+
+  def exist? page_title
+    self.page(page_title) != nil
+  end
+
+  # スペースの入ったページ名などダメなページ名があるので
+  # 返り値として移動後のページ名を返す
+  def rename before_title, after_title, parent_title = :default
+    def get_page_title_id_map nokogiri_doc
+      page_id_and_anme = nokogiri_doc.css('#wiki_page_parent_id option').
+        map { |i| i.text =~ /(?:.*» )?(.+)/; [$1, i.attributes['value'].value.to_i] }.
+        select { |page_title, id| page_title }
+      Hash[page_id_and_anme]
+    end
+
+    def get_default_parent_id nokogiri_doc
+      elem = nokogiri_doc.css('#wiki_page_parent_id option[selected="selected"]').first
+      if elem
+        elem.attributes['value'].value.to_i
+      else
+        ''
+      end
+    end
+
+    rename_form_url = File.join(@wiki_root, before_title, '/rename')
+    doc = Nokogiri::HTML(@http_client.get_content(rename_form_url))
+    authenticity_token = get_authenticity_token(doc)
+    parent_id = if parent_title == :default
+                  get_default_parent_id(doc)
+                elsif parent_title == nil
+                  ''
+                else
+                  page_title_to_id = get_page_title_id_map(doc)
+                  unless page_title_to_id.has_key? parent_title
+                    raise '指定された親ページが存在しません'
+                  end
+                  page_title_to_id[parent_title]
+                end
+
+    res = @http_client.post(rename_form_url, {
+      'authenticity_token'                 => authenticity_token,
+      'wiki_page[title]'                   => after_title,
+      'wiki_page[redirect_existing_links]' => 0,
+      'wiki_page[parent_id]'               => parent_id
+    })
+    check_status_code res, 302
+    File.basename(res.header['Location'].first)
+  end
+
+  private
+  def login username, password
+    def fetch_login_url_from_wiki_root
+      url = URI.parse(@wiki_root)
+      doc = Nokogiri::HTML(@http_client.get_content(@wiki_root))
+      url.path = doc.css('.login').first.attributes['href'].value
+      url.to_s
+    end
+
+    login_url = fetch_login_url_from_wiki_root
+    login_page_doc = Nokogiri::HTML(@http_client.get_content(login_url))
+    authenticity_token = get_authenticity_token(login_page_doc)
+    # redmineは認証失敗したら200,成功したら302が帰る。ks
+    check_status_code(@http_client.post(login_url, {
+      authenticity_token: authenticity_token,
+      username: username,
+      password: password
+    }), 302)
+  end
+
+  def check_status_code response, status_code = 200
+    unless response.header.status_code == status_code
+      raise '失敗したっぽい' + response.to_s
+    end
+  end
+
+  def get_authenticity_token nokogiri_doc
+    nokogiri_doc.css('input[name="authenticity_token"]').first.attributes['value'].value
+  end
+end

data/rmwiki.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rmwiki'
+  spec.version       = '0.0.1'
+  spec.authors       = ['bigwheel']
+  spec.email         = ['k.bigwheel+eng@gmail.com']
+  spec.summary       = %q{redmine wiki manupilator}
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httpclient'
+  spec.add_runtime_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/spec/rmwiki_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Rmwiki do
+  # sample site
+  wiki_root = 'https://www.hostedredmine.com/projects/redminefs-test-project/wiki/'
+  username = 'bigwheel'
+  password = '4CrY39Ellb07'
+  it '正しいアカウントならインスタンスが作れる' do
+    expect { Rmwiki.new(wiki_root, username, password) }.not_to raise_error
+  end
+
+  it '正しくないアカウントでは例外が出る' do
+    expect { Rmwiki.new(wiki_root, username, 'invalid_pass') }.to raise_error
+  end
+
+  describe '細かい挙動' do
+    before(:context) do
+      @subject = Rmwiki.new(wiki_root, username, password)
+    end
+
+    it 'とりあえずall_pagesが呼べる' do
+      expect { @subject.all_pages }.not_to raise_error
+    end
+
+    it 'とりあえずページ詳細が取れる' do
+      page = @subject.page('C')
+
+      expect(page.title).to eq('C')
+      expect(page.parent_title).to eq('Parent')
+      expect(page.text).not_to be_empty
+      expect(page.author_name).to eq('bigwheel k')
+      expect(page.author_id).to eq(33563)
+      expect(page.created_on).to eq(DateTime.parse('2014-09-24T18:13:16Z'))
+    end
+
+    it 'ページの存在を確認できる' do
+      expect(@subject.exist?('C')).to be_truthy
+    end
+
+    it 'ページの不在を確認できる' do
+      expect(@subject.exist?('not_exists')).to be_falsey
+    end
+
+    it '存在しないページの詳細を取ろうとするとnilが帰る' do
+      expect(@subject.page('not_exists')).to be_nil
+    end
+
+    it '親がないページのrenameテスト' do
+      expect(@subject.exist?('A')).to be_truthy
+      expect(@subject.exist?('B')).to be_falsey
+
+      @subject.rename 'A', 'B'
+
+      expect(@subject.exist?('A')).to be_falsey
+      expect(@subject.exist?('B')).to be_truthy
+
+      @subject.rename 'B', 'A' # 面倒なので元に戻しておく
+    end
+
+    it '親があるページのrenameテスト' do
+      expect(@subject.exist?('Child')).to be_truthy
+      expect(@subject.exist?('NextChild')).to be_falsey
+
+      @subject.rename 'Child', 'NextChild'
+
+      expect(@subject.exist?('Child')).to be_falsey
+      expect(@subject.exist?('NextChild')).to be_truthy
+
+      @subject.rename 'NextChild', 'Child' # 面倒なので元に戻しておく
+    end
+
+    it 'スペースを含む名前へ変更しようとしてもアンダースコアで置換される' do
+      renamed_name = @subject.rename 'A', 'Space Ga Aru'
+      @subject.rename renamed_name, 'A' # 元に戻しておく
+      expect(renamed_name).to eq('Space_Ga_Aru')
+    end
+
+    it '親のあるページを別の親へ移動できる' do
+      @subject.rename 'Child', 'Child', 'Wiki'
+
+      page = @subject.page('Child')
+      expect(page.parent_title).to eq('Wiki')
+
+      @subject.rename 'Child', 'Child', 'Parent' # 元に戻しておく
+    end
+
+    it '親のないページを別の親へ移動できる' do
+      @subject.rename 'Parentless', 'Parentless', 'Wiki'
+
+      page = @subject.page('Parentless')
+      expect(page.parent_title).to eq('Wiki')
+    end
+
+    # 上のテストの副作用はこっちで戻す
+    it '親のあるページを親なしへ移動できる' do
+      @subject.rename 'Parentless', 'Parentless', nil
+
+      page = @subject.page('Parentless')
+      expect(page.parent_title).to be_nil
+    end
+
+    it '存在しない親ページを指定すると例外が出る' do
+      expect {
+        @subject.rename('Parentless', 'Parentless', 'not_exist_page')
+      }.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rmwiki'
+require 'pry'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: rmwiki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bigwheel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.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: 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: redmine wiki manupilator
+email:
+- k.bigwheel+eng@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rmwiki.rb
+- rmwiki.gemspec
+- spec/rmwiki_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: redmine wiki manupilator
+test_files:
+- spec/rmwiki_spec.rb
+- spec/spec_helper.rb