sync_readme 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ba1afc35004193ffabf9193ee396e6f53e4a4a5
-  data.tar.gz: 9f89d7cb5e2aaf0e4970f6fd7949184c5f0cfc51
+  metadata.gz: 5aae0ad2a0988f1ab3b183584b9c3be86c5bc013
+  data.tar.gz: 44f347b0583e8d4ca3d1747c7937771f88e5ae8c
 SHA512:
-  metadata.gz: caa4072c8f7e3e41dbaabe1de190edaa4942d38c293bbb9e45bc9b735c799dd2210d421d525cfd48097996354a99275184eae1f0919b7f7d9d8d4bc51e5918fc
-  data.tar.gz: 0ff87c4d310577499a9b5aa7dbc0199437b5e5d3cd39440c6203830cd7f09ffba39965f0006d341ca542a60ec3ded04684dde2f5e648cfb714796c46d7dd85b8
+  metadata.gz: 5e9b679d27ee036868e06633687a98091d39ef8d2156ccb4751ae5286211cdd8889709edc0e7a864e839a68c27854e2670e185a82c1bfde5272d674b50f1021c
+  data.tar.gz: 5d17aadfbc0335682eeec7917700ba87d4f67dd18f73a530beda3312b5f036b0834650cb708d722111302d271e61916fe0b37118eca21c710ca11e99f3b6d8a1

data/README.md

@@ -27,26 +27,33 @@ readme:
   url: http://confluence.url.here   # required
   page_id: 123456                   # required
   filename: Readme.md               # required
-  username: foo                     # optional, generally better as an environment variable
-  password: bar                     # optional, generally better as an environment variable
+  username: foo                     # optional, can be prompted for or put in an environment variable
+  password: bar                     # optional, can be prompted for or put in an environment variable
   notice: this file is sync'd!      # optional, adds the notice (as html) to the top of the confluance docs
   strip_title: false                # optional, defaults false, strips the first h1 (#) tag from the file
-  syntax_highlighting: true         # optional, defaults true, uses coderay sytax highlighting on code blocks
+  syntax_highlighting: true         # optional, defaults true, uses coderay syntax highlighting on code blocks
 ```
 
-You'll also need to set environment variables with credentials to update the page in question:
+You can also set the following in your environment (ex: continuous integration) to store credentials:
 
 ```
 CONFLUENCE_USERNAME=jsmith
 CONFLUENCE_PASSWORD=$UPER $ECURE PA$$WORD
 ```
 
+The Atlassian Cloud supports [API tokens](https://confluence.atlassian.com/cloud/api-tokens-938839638.html), which can be used for `CONFLUENCE_PASSWORD`
+
+If credentials are not stored anywhere, they are prompted for at run time.
+
 ## Usage
 ```
-sync_readme [configuration]
+sync_readme [options] [profile]
+    -u, --user=username              Confluence username
+    -a, --all                        Run all configured syncronizations
+    -h, --help                       Show help
 ```
 
-## Adding to Gitlab-CI
+## Using in Gitlab-CI
 
 1. Create a confluence user specifically to sync with
 2. If you haven't already, create the pages you want to sync to on confluence and get their IDs.
@@ -54,13 +61,14 @@ sync_readme [configuration]
 4. Add `gem 'sync_readme'` to your apps gemfile
 5. Set `CONFLUENCE_USERNAME` and `CONFLUENCE_PASSWORD` as CI Variables. 
 6. Add the following job to your .gitlab-ci.yml 
-   ``` yaml
-   Sync To Confluence:
-     stage: update_docs                # Replace that with the stage you want this to run
-     only: master                      # Only run on master branch probably after you deploy
-     script:
-       - bundle exec sync_readme --all # Alternately just the profile you want to run
-    ```
+
+```yaml
+Sync To Confluence:
+  stage: update_docs                # Replace that with the stage you want this to run
+  only: master                      # Only run on master branch probably after you deploy
+  script:
+    - bundle exec sync_readme --all # Alternately just the profile you want to run
+```
 
 ## Development
 

data/lib/sync_readme/config.rb

@@ -1,15 +1,15 @@
 require 'yaml'
-
 module SyncReadme
   class Config
     DEFAULT_CONFIG_FILE = File.join(Dir.pwd, '.sync_readme.yml')
-    NO_CONFIGURATION_ERROR = "this profile has not been configured, please add it to #{DEFAULT_CONFIG_FILE}".freeze
+    NO_CONFIGURATION_ERROR = SyncReadme::NoConfigurationError.new("this profile has not been configured, please add it to #{DEFAULT_CONFIG_FILE}".freeze)
 
     def self.profiles(config_file = DEFAULT_CONFIG_FILE)
       YAML.load_file(config_file).keys.select { |key| key != 'default' }
     end
 
     def self.default(config_file = DEFAULT_CONFIG_FILE)
+      raise NO_CONFIGURATION_ERROR unless File.exists?(config_file)
       default = YAML.load_file(config_file)['default']
       unless default
         profiles = SyncReadme::Config.profiles(config_file)

data/lib/sync_readme/confluence_sync.rb

@@ -19,13 +19,13 @@ module SyncReadme
     end
 
     def get_page
-      response = @client.get("/rest/api/content/#{@page_id}", expand: 'body.view,version')
+      response = @client.get("rest/api/content/#{@page_id}", expand: 'body.view,version')
       JSON.parse(response.body)
     end
 
     def update(params)
       @client.put do |request|
-        request.url "/rest/api/content/#{@page_id}"
+        request.url "rest/api/content/#{@page_id}"
         request.headers['Content-Type'] = 'application/json'
         request.body = params.to_json
       end

data/lib/sync_readme/errors.rb

@@ -0,0 +1,7 @@
+module SyncReadme
+
+  class Error < RuntimeError
+  end
+  class NoConfigurationError < Error
+  end
+end

data/lib/sync_readme/version.rb

@@ -1,3 +1,3 @@
 module SyncReadme
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/sync_readme.rb

@@ -1,9 +1,11 @@
+require 'sync_readme/errors'
 require 'sync_readme/config'
 require 'sync_readme/confluence_sync'
 require 'sync_readme/reader'
 require 'sync_readme/version'
 require 'optparse'
 require 'dotenv'
+require 'highline/import'
 
 Dotenv.load
 
@@ -11,13 +13,26 @@ module SyncReadme
   def self.invoke(args)
     options = {}
     OptionParser.new do |opts|
-      opts.banner = "Usage: sync_readme [options] [profile]"
+      opts.banner = 'Usage: sync_readme [options] [profile]'
 
-      opts.on("-a", "--all", "Run verbosely") do
+      opts.on('-u', '--user=username', String, 'Confluence username') do |user|
+        ENV['CONFLUENCE_USERNAME'] = user
+        ENV['CONFLUENCE_PASSWORD'] = ask("Password for #{user}: ") { |q| q.echo = false }
+      end
+
+      opts.on('-a', '--all', 'Run all configured syncronizations') do
         options[:all] = true
       end
+
+      opts.on_tail('-h', '--help', 'Show help') do
+        puts opts
+        exit
+      end
     end.parse!(args)
 
+    ENV['CONFLUENCE_USERNAME'] ||= ask("Confluence username: ")
+    ENV['CONFLUENCE_PASSWORD'] ||= ask("Password for #{ENV['CONFLUENCE_USERNAME']}: ") { |q| q.echo = false }
+
     default_profile = SyncReadme::Config.default
 
     if options[:all] || (args.empty? && default_profile.nil?)
@@ -29,6 +44,10 @@ module SyncReadme
     else
       SyncReadme.perform(args.last)
     end
+
+  rescue SyncReadme::Error => sre
+    STDERR.puts sre.message
+    exit 1
   end
 
   def self.perform(profile)

data/sync_readme.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'faraday', '~> 0.11'
   spec.add_dependency 'kramdown', '~> 1.13'
-  spec.add_dependency 'dotenv', '~> 2.1.2'
+  spec.add_dependency 'dotenv', '~> 2'
+  spec.add_dependency 'highline', '~> 1'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_readme
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Ives
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,7 @@ files:
 - lib/sync_readme.rb
 - lib/sync_readme/config.rb
 - lib/sync_readme/confluence_sync.rb
+- lib/sync_readme/errors.rb
 - lib/sync_readme/reader.rb
 - lib/sync_readme/version.rb
 - sync_readme.gemspec