capistrano_api_docs_external_git 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2666f91d3e3a714f9282d23f5abda70ac6e6748
+  data.tar.gz: e85060dbc9aba916d450ef9545815e25590037d9
+SHA512:
+  metadata.gz: 2c98d166acaa3837576d047cfcdf4ace00512c141b5caf301c6f071be8253bc438f4f914afa09e1a787f3214b5feb72895beae3350f68767a1dbfa17e625eedc
+  data.tar.gz: 2a76fdb0fbc8e10e55cf2f9476fb3230493384f62a7cd72852dfaca49b8001d24ecc7691614b1701d7611430ba67e3a1cec0da305cb62c11b3aef89a49312924

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    capistrano_api_docs_external_git (1.0.0)
+      git
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    git (1.2.8)
+    rake (10.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  capistrano_api_docs_external_git!
+  rake (~> 10.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Guilherme Pereira
+
+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,65 @@
+capistranoApiDocsExternalGit
+=================
+
+Add tasks to capistrano to a Rails project to work with gem api_docs.
+It only works with capistrano 3. Older versions until 0.3 works with capistrano 2.
+
+Currently
+
+* Add documentation files to git
+* Clone documentation repository to tmp folder
+* Copy documentation files from local respository to documentation repository
+* Remove temporary documentation repository
+
+Feel free to fork and to add new tasks.
+
+Install
+=======
+
+Add it as a gem:
+
+```ruby
+    gem "capistrano_api_docs_external_git"
+```
+
+Change your Capfile:
+
+```ruby
+   require 'capistrano/api_docs_external_git'
+```
+
+Add if you want change any of this options on your config/deploy.rb:
+```ruby
+    # This one is required
+    # Set Your destination git repository e.g. (git@github.com:guiferrpereira/api-docs.git)
+    set :doc_git_repository, nil
+
+    # Optionals
+    # Set Your destination repository name e.g. "api-docs"
+    set :doc_repository_name, "api-docs"
+    # Rails Application root folder
+    set :rails_root, Pathname.new(Dir.pwd)
+    # Temporary folder where you want save git repository temporary
+    set :rails_root_tmp_path, fetch(:rails_root).join("tmp")
+    # You should set with ApiDocs.config.docs_path
+    set :api_docs_path, fetch(:rails_root).join("doc", "api")
+```
+
+Available tasks
+===============
+
+    cap api_docs_external_git:add_files_git  # Add files to documentation git
+    cap api_docs_external_git:clone_repo     # Clone documentation repository to tmp folder
+    cap api_docs_external_git:copy_files     # Copy documentation files from local respository to documentation repository
+    cap api_docs_external_git:remove_files   # Remove documentation repository
+
+Example
+=======
+
+    By default will run after your deploy is finished
+
+TODO
+====
+* Add tests
+
+Copyright (c) 2014 [Guilherme Pereira - NDrive], released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano_api_docs_external_git.gemspec

@@ -0,0 +1,24 @@
+# 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          = "capistrano_api_docs_external_git"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Guilherme Pereira"]
+  spec.email         = ["guilherme.pereira@ndrive.com"]
+  spec.summary       = %q{Add tasks to capistrano to a Rails project to work with gem api_docs.}
+  spec.description   = %q{Add tasks to capistrano to a Rails project to work with gem api_docs, and send files remotely to other git repository}
+  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_dependency 'git', "~> 1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/api_docs_external_git.rb

@@ -0,0 +1,3 @@
+require 'git'
+
+load File.expand_path('../tasks/api_docs_external_git.rb', __FILE__)

data/lib/capistrano/tasks/api_docs_external_git.rb

@@ -0,0 +1,56 @@
+namespace :api_docs_external_git do
+
+  set :doc_git_repository, nil
+  set :doc_repository_name, "api-docs"
+  set :rails_root, Pathname.new(Dir.pwd)
+  set :rails_root_tmp_path, fetch(:rails_root).join("tmp")
+  # You should set with ApiDocs.config.docs_path
+  set :api_docs_path, fetch(:rails_root).join("doc", "api")
+
+  task :setup do
+    puts "**********************************"
+    puts "Updating API Documentation"
+    puts "**********************************"
+
+    invoke :'api_docs_external_git:clone_repo'
+    invoke :'api_docs_external_git:copy_files'
+    invoke :'api_docs_external_git:add_files_git'
+    invoke :'api_docs_external_git:raise_exception'
+  end
+
+  desc 'Clone documentation repository to tmp folder'
+  task :clone_repo do
+    puts "Cloning #{fetch(:doc_git_repository).to_s} for temporary folder"
+    @git_repo = Git.clone(fetch(:doc_git_repository), fetch(:doc_repository_name), path: fetch(:rails_root_tmp_path))
+  end
+
+  desc 'Copy documentation files from local respository to documentation repository'
+  task :copy_files do
+    files = Dir.glob(fetch(:api_docs_path).join('*.{yml,md}'))
+    destination_folder = fetch(:rails_root_tmp_path).join(fetch(:doc_repository_name), fetch(:api_docs_path).relative_path_from(fetch(:rails_root)))
+
+    puts "Copying documentation files"
+    FileUtils.cp_r files, destination_folder
+  end
+
+  desc 'Remove documentation repository'
+  task :remove_files do
+    puts "Removing documentation repository"
+    FileUtils.rm_r fetch(:rails_root_tmp_path).join(fetch(:doc_repository_name))
+  end
+
+  desc 'Add files to documentation git'
+  task :add_files_git do
+    puts "Saving documentation files on git repository"
+    @git_repo.add(all: true)
+    begin
+      @git_repo.commit_all('Automatic add documentation')
+      @git_repo.push
+    rescue Git::GitExecuteError => e
+      invoke :'api_docs_external_git:remove_files'
+      raise e unless e.message.include?("nothing to commit")
+    end
+  end
+
+  before 'deploy:finishing', 'api_docs_external_git:setup'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: capistrano_api_docs_external_git
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Guilherme Pereira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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'
+description: Add tasks to capistrano to a Rails project to work with gem api_docs,
+  and send files remotely to other git repository
+email:
+- guilherme.pereira@ndrive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano_api_docs_external_git.gemspec
+- lib/capistrano/api_docs_external_git.rb
+- lib/capistrano/tasks/api_docs_external_git.rb
+- lib/capistrano_api_docs_external_git.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.4.3
+signing_key: 
+specification_version: 4
+summary: Add tasks to capistrano to a Rails project to work with gem api_docs.
+test_files: []