knife-stash 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.0
+
+* Backend class refactoring
+
 ## v0.1.0
 
 * Initial release

data/README.md

@@ -2,9 +2,15 @@
 
 A knife plugin for Atlassian Stash.
 
+[![Gem Version](https://badge.fury.io/rb/knife-stash.png)](http://badge.fury.io/rb/knife-stash)
+ 
+[![Code Climate](https://codeclimate.com/github/bflad/knife-stash.png)](https://codeclimate.com/github/bflad/knife-stash)
+
 ## Installation
 
-* Clone repo to ~/.chef/plugins/knife or path/to/cheforg/.chef/plugins/knife
+* `gem install knife-rhn` (if using omnibus install, `/opt/chef/embedded/bin/gem install knife-rhn`)
+* or... copy `lib/chef/knife/*` files to `~/.chef/plugins/knife`
+* or... copy `lib/chef/knife/*` files to `path/to/cheforg/.chef/plugins/knife`
 
 ## Usage
 

data/lib/chef/knife/stash_base.rb

@@ -0,0 +1,97 @@
+#
+# Author:: Brian Flad (<bflad417@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'highline/import'
+require 'faraday'
+
+class Chef
+  class Knife
+    module StashBase
+
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'readline'
+            require 'chef/json_compat'
+          end
+
+          unless defined? $default
+            $default = Hash.new
+          end
+
+          option :noop,
+            :long => "--noop",
+            :description => "Perform no modifying operations",
+            :boolean => false
+
+          option :stash_username,
+            :short => "-u USERNAME",
+            :long => "--stash-username USERNAME",
+            :description => "The username for Stash"
+          $default[:stash_username] = ENV['USER']
+
+          option :stash_password,
+            :short => "-p PASSWORD",
+            :long => "--stash-password PASSWORD",
+            :description => "The password for Stash"
+
+      		option :stash_hostname,
+      			:long => "--stash-hostname HOSTNAME",
+      			:description => "The hostname for Stash"
+        end
+    	end
+
+      def display_stash_error(message,response)
+        ui.fatal message
+        JSON.parse(response.body)['errors'].each do |error|
+          ui.fatal "#{error['context'] ? error['context'] + ": " : "" }#{error['message']}"
+        end
+      end
+
+      def get_all_values(stash,url,response)
+        r = JSON.parse(response.body)
+        yield r['values']
+        until r['isLastPage']
+          response = stash.get url, { :start => r['nextPageStart'] }
+          r = JSON.parse(response.body)
+          yield r['values']
+        end
+      end
+
+    	def get_config(key)
+    		key = key.to_sym
+    		rval = config[key] || Chef::Config[:knife][key] || $default[key]
+    		Chef::Log.debug("value for config item #{key}: #{rval}")
+    		rval
+    	end
+
+    	def get_stash_connection
+        config[:stash_hostname] = ask("Stash Hostname: ") { |q| q.echo = "*" } unless get_config(:stash_hostname)
+        config[:stash_username] = ask("Stash Username for #{get_config(:stash_hostname)}: ") { |q| q.echo = "*" } unless get_config(:stash_username)
+        config[:stash_password] = ask("Stash Password for #{get_config(:stash_username)}: ") { |q| q.echo = "*" } unless get_config(:stash_password)
+        
+        connection = Faraday.new(:url => "https://#{get_config(:stash_hostname)}", :ssl => {:verify => false}) do |faraday|
+          faraday.request  :url_encoded # form-encode POST params
+          #faraday.response :logger      # log requests to STDOUT
+          faraday.adapter  :net_http    # make requests with Net::HTTP
+        end
+        connection.basic_auth(get_config(:stash_username),get_config(:stash_password))
+        connection.url_prefix = "https://#{get_config(:stash_hostname)}/rest/api/1.0"
+        connection
+    	end
+
+      def get_repo_https_url(project_key,repo)
+        "https://#{get_config(:stash_username)}@#{get_config(:stash_hostname)}/scm/#{project_key}/#{repo}.git"
+      end
+
+      def get_repo_ssh_url(project_key,repo)
+        "ssh://git@#{get_config(:stash_hostname)}:7999/#{project_key}/#{repo}.git"
+      end
+
+    end
+  end
+end

data/lib/chef/knife/stash_project_create.rb

@@ -3,66 +3,68 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashProjectCreate < Knife
 
-  class StashProjectCreate < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash project create KEY NAME (options)"
-    category "stash"
+      banner "knife stash project create KEY NAME (options)"
+      category "stash"
 
-    option :description,
-        :short => "-d DESCRIPTION",
-        :long => "--description DESCRIPTION",
-        :description => "The description for the project"
+      option :description,
+          :short => "-d DESCRIPTION",
+          :long => "--description DESCRIPTION",
+          :description => "The description for the project"
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        key = name_args.first
 
-    def run
-      
-      key = name_args.first
-
-      if key.nil?
-        ui.fatal "You need a project key!"
-        show_usage
-        exit 1
-      end
+        if key.nil?
+          ui.fatal "You need a project key!"
+          show_usage
+          exit 1
+        end
 
-      name = name_args[1]
+        name = name_args[1]
 
-      if name.nil?
-        ui.fatal "You need a project name!"
-        show_usage
-        exit 1
-      end
+        if name.nil?
+          ui.fatal "You need a project name!"
+          show_usage
+          exit 1
+        end
 
-      args = name_args[2]
-      if args.nil?
-        args = ""
-      end
+        args = name_args[2]
+        if args.nil?
+          args = ""
+        end
 
-      stash = get_stash_connection
-      project = { :name => name, :key => key }
-      project[:description] = get_config(:description) if get_config(:description)
+        stash = get_stash_connection
+        project = { :name => name, :key => key }
+        project[:description] = get_config(:description) if get_config(:description)
 
-      if get_config(:noop)
-        ui.info "#{ui.color "Skipping project creation process because --noop specified.", :red}"
-      else
-        response = stash.post do |post|
-          post.url "projects"
-          post.headers['Content-Type'] = "application/json"
-          post.body = JSON.generate(project)
-        end
-        if response.success?
-          ui.info "Created Stash Project: #{key} (#{name})"
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping project creation process because --noop specified.", :red}"
         else
-          display_stash_error "Could not create Stash project!", response
-          exit 1
+          response = stash.post do |post|
+            post.url "projects"
+            post.headers['Content-Type'] = "application/json"
+            post.body = JSON.generate(project)
+          end
+          if response.success?
+            ui.info "Created Stash Project: #{key} (#{name})"
+          else
+            display_stash_error "Could not create Stash project!", response
+            exit 1
+          end
         end
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/chef/knife/stash_project_delete.rb

@@ -3,64 +3,66 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashProjectDelete < Knife
 
-  class StashProjectDelete < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash project delete KEY (options)"
-    category "stash"
+      banner "knife stash project delete KEY (options)"
+      category "stash"
 
-    option :delete_repos,
-        :short => "-d",
-        :long => "--delete-repos",
-        :description => "Delete all repositories in project.",
-        :boolean => false
+      option :delete_repos,
+          :short => "-d",
+          :long => "--delete-repos",
+          :description => "Delete all repositories in project.",
+          :boolean => false
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        key = name_args.first
 
-    def run
-      
-      key = name_args.first
-
-      if key.nil?
-        ui.fatal "You need a project key!"
-        show_usage
-        exit 1
-      end
+        if key.nil?
+          ui.fatal "You need a project key!"
+          show_usage
+          exit 1
+        end
 
-      stash = get_stash_connection
+        stash = get_stash_connection
 
-      if get_config(:noop)
-        ui.info "#{ui.color "Skipping project deletion process because --noop specified.", :red}"
-      else
-        if get_config(:delete_repos)
-          url = "projects/#{key}/repos"
-          response = stash.get url
-          if response.success?
-            get_all_values stash,url,response do |values|
-              values.each do |repo|
-                repo_delete = StashRepoDelete.new
-                repo_delete.name_args = [ key, repo['name'] ]
-                repo_delete.run
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping project deletion process because --noop specified.", :red}"
+        else
+          if get_config(:delete_repos)
+            url = "projects/#{key}/repos"
+            response = stash.get url
+            if response.success?
+              get_all_values stash,url,response do |values|
+                values.each do |repo|
+                  repo_delete = StashRepoDelete.new
+                  repo_delete.name_args = [ key, repo['name'] ]
+                  repo_delete.run
+                end
               end
+            else
+              display_stash_error "Could not delete Stash project repositories!", response
+              exit 1
             end
+          end
+          response = stash.delete "projects/#{key}"
+          if response.success?
+            ui.info "Deleted Stash Project: #{key}"
           else
-            display_stash_error "Could not delete Stash project repositories!", response
+            display_stash_error "Could not delete Stash project!", response
             exit 1
           end
         end
-        response = stash.delete "projects/#{key}"
-        if response.success?
-          ui.info "Deleted Stash Project: #{key}"
-        else
-          display_stash_error "Could not delete Stash project!", response
-          exit 1
-        end
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/chef/knife/stash_project_repos.rb

@@ -3,43 +3,45 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashProjectRepos < Knife
 
-  class StashProjectRepos < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash project repos KEY (options)"
-    category "stash"
+      banner "knife stash project repos KEY (options)"
+      category "stash"
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        key = name_args.first
 
-    def run
-      
-      key = name_args.first
-
-      if key.nil?
-        ui.fatal "You need a project key!"
-        show_usage
-        exit 1
-      end
+        if key.nil?
+          ui.fatal "You need a project key!"
+          show_usage
+          exit 1
+        end
 
-      stash = get_stash_connection
-      url = "projects/#{key}/repos"
-      response = stash.get url
+        stash = get_stash_connection
+        url = "projects/#{key}/repos"
+        response = stash.get url
 
-      if response.success?
-        get_all_values stash,url,response do |values|
-          values.each do |repo|
-            ui.info "#{repo['slug']} (#{repo['name']})"
+        if response.success?
+          get_all_values stash,url,response do |values|
+            values.each do |repo|
+              ui.info "#{repo['slug']} (#{repo['name']})"
+            end
           end
+        else
+          display_stash_error "Could not list Stash project repositories!", response
+          exit 1
         end
-      else
-        display_stash_error "Could not list Stash project repositories!", response
-        exit 1
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/chef/knife/stash_projects.rb

@@ -3,35 +3,37 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashProjects < Knife
 
-  class StashProjects < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash projects (options)"
-    category "stash"
+      banner "knife stash projects (options)"
+      category "stash"
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        stash = get_stash_connection
+        url = "projects"
+        response = stash.get url
 
-    def run
-      
-      stash = get_stash_connection
-      url = "projects"
-      response = stash.get url
-
-      if response.success?
-        get_all_values stash,url,response do |values|
-          values.each do |project|
-            ui.info "#{project['key']}: #{project['name']}"
+        if response.success?
+          get_all_values stash,url,response do |values|
+            values.each do |project|
+              ui.info "#{project['key']}: #{project['name']}"
+            end
           end
+        else
+          display_stash_error "Could not list Stash projects!", response
+          exit 1
         end
-      else
-        display_stash_error "Could not list Stash projects!", response
-        exit 1
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/chef/knife/stash_repo_create.rb

@@ -3,62 +3,64 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashRepoCreate < Knife
 
-  class StashRepoCreate < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash repo create PROJECT_KEY NAME (options)"
-    category "stash"
+      banner "knife stash repo create PROJECT_KEY NAME (options)"
+      category "stash"
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        project_key = name_args.first
 
-    def run
-      
-      project_key = name_args.first
-
-      if project_key.nil?
-        ui.fatal "You need a project key!"
-        show_usage
-        exit 1
-      end
+        if project_key.nil?
+          ui.fatal "You need a project key!"
+          show_usage
+          exit 1
+        end
 
-      name = name_args[1]
+        name = name_args[1]
 
-      if name.nil?
-        ui.fatal "You need a repository name!"
-        show_usage
-        exit 1
-      end
+        if name.nil?
+          ui.fatal "You need a repository name!"
+          show_usage
+          exit 1
+        end
 
-      args = name_args[2]
-      if args.nil?
-        args = ""
-      end
+        args = name_args[2]
+        if args.nil?
+          args = ""
+        end
 
-      stash = get_stash_connection
-      repo = { :name => name, :scmId => "git" }
+        stash = get_stash_connection
+        repo = { :name => name, :scmId => "git" }
 
-      if get_config(:noop)
-        ui.info "#{ui.color "Skipping repo creation process because --noop specified.", :red}"
-      else
-        response = stash.post do |post|
-          post.url "projects/#{project_key}/repos"
-          post.headers['Content-Type'] = "application/json"
-          post.body = JSON.generate(repo)
-        end
-        if response.success?
-          ui.info "Created Stash Repository: #{project_key}/#{name}"
-          ui.info "Available via (HTTPS): #{get_repo_https_url(project_key,name)}"
-          ui.info "Available via (SSH): #{get_repo_ssh_url(project_key,name)}"
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping repo creation process because --noop specified.", :red}"
         else
-          display_stash_error "Could not create Stash repository!", response
-          exit 1
+          response = stash.post do |post|
+            post.url "projects/#{project_key}/repos"
+            post.headers['Content-Type'] = "application/json"
+            post.body = JSON.generate(repo)
+          end
+          if response.success?
+            ui.info "Created Stash Repository: #{project_key}/#{name}"
+            ui.info "Available via (HTTPS): #{get_repo_https_url(project_key,name)}"
+            ui.info "Available via (SSH): #{get_repo_ssh_url(project_key,name)}"
+          else
+            display_stash_error "Could not create Stash repository!", response
+            exit 1
+          end
         end
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/chef/knife/stash_repo_delete.rb

@@ -3,50 +3,52 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashRepoDelete < Knife
 
-  class StashRepoDelete < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash repo delete KEY REPO (options)"
-    category "stash"
+      banner "knife stash repo delete KEY REPO (options)"
+      category "stash"
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        key = name_args.first
 
-    def run
-      
-      key = name_args.first
-
-      if key.nil?
-        ui.fatal "You need a project key!"
-        show_usage
-        exit 1
-      end
+        if key.nil?
+          ui.fatal "You need a project key!"
+          show_usage
+          exit 1
+        end
 
-      repo = name_args[1]
+        repo = name_args[1]
 
-      if repo.nil?
-        ui.fatal "You need a repository name!"
-        show_usage
-        exit 1
-      end
+        if repo.nil?
+          ui.fatal "You need a repository name!"
+          show_usage
+          exit 1
+        end
 
-      stash = get_stash_connection
+        stash = get_stash_connection
 
-      if get_config(:noop)
-        ui.info "#{ui.color "Skipping project repository deletion process because --noop specified.", :red}"
-      else
-        response = stash.delete "projects/#{key}/repos/#{repo}"
-        if response.success?
-          ui.info "Deleted Stash Repository: #{key}/#{repo}"
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping project repository deletion process because --noop specified.", :red}"
         else
-          display_stash_error "Could not delete Stash respository!", response
-          exit 1
+          response = stash.delete "projects/#{key}/repos/#{repo}"
+          if response.success?
+            ui.info "Deleted Stash Repository: #{key}/#{repo}"
+          else
+            display_stash_error "Could not delete Stash respository!", response
+            exit 1
+          end
         end
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/chef/knife/stash_repos.rb

@@ -3,47 +3,49 @@
 # License:: Apache License, Version 2.0
 #
 
-module StashKnifePlugin
+require 'chef/knife/stash_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class StashRepos < Knife
 
-  class StashRepos < BaseStashCommand
+      include Knife::StashBase
 
-    banner "knife stash repos (options)"
-    category "stash"
+      banner "knife stash repos (options)"
+      category "stash"
 
-    get_common_options
+      def run
+        $stdout.sync = true
 
-    def run
+        stash = get_stash_connection
+        url = "projects"
+        project_response = stash.get url
 
-      stash = get_stash_connection
-      url = "projects"
-      project_response = stash.get url
+        if project_response.success?
+          get_all_values stash,url,project_response do |project_values|
+            project_values.each do |project|
+              url = "projects/#{project['key']}/repos"
+              repo_response = stash.get url
 
-      if project_response.success?
-        get_all_values stash,url,project_response do |project_values|
-          project_values.each do |project|
-            url = "projects/#{project['key']}/repos"
-            repo_response = stash.get url
-
-            if repo_response.success?
-              get_all_values stash,url,repo_response do |repo_values|
-                repo_values.each do |repo|
-                  ui.info "#{project['key']}/#{repo['slug']}"
+              if repo_response.success?
+                get_all_values stash,url,repo_response do |repo_values|
+                  repo_values.each do |repo|
+                    ui.info "#{project['key']}/#{repo['slug']}"
+                  end
                 end
+              else
+                display_stash_error "Could not list Stash project repositories!", repo_response
+                exit 1
               end
-            else
-              display_stash_error "Could not list Stash project repositories!", repo_response
-              exit 1
             end
           end
+        else
+          display_stash_error "Could not list Stash projects!", project_response
+          exit 1
         end
-      else
-        display_stash_error "Could not list Stash projects!", project_response
-        exit 1
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/knife-stash/version.rb

@@ -1,5 +1,6 @@
 module Knife
   module Stash
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
+    MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-stash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,7 +40,7 @@ files:
 - README.md
 - Rakefile
 - knife-stash.gemspec
-- lib/chef/knife/BaseStashCommand.rb
+- lib/chef/knife/stash_base.rb
 - lib/chef/knife/stash_project_create.rb
 - lib/chef/knife/stash_project_delete.rb
 - lib/chef/knife/stash_project_repos.rb

data/lib/chef/knife/BaseStashCommand.rb

@@ -1,93 +0,0 @@
-#
-# Author:: Brian Flad (<bflad417@gmail.com>)
-# License:: Apache License, Version 2.0
-#
-
-module StashKnifePlugin
-
-  require 'chef/knife'
-  require 'highline/import'
-  require 'faraday'
-  
-  class BaseStashCommand < Chef::Knife
-
-    deps do
-      require 'highline/import'
-    end
-
-  	def self.get_common_options
-  		unless defined? $default
-  			$default = Hash.new
-  		end
-
-      option :noop,
-        :long => "--noop",
-        :description => "Perform no modifying operations",
-        :boolean => false
-
-      option :stash_username,
-        :short => "-u USERNAME",
-        :long => "--stash-username USERNAME",
-        :description => "The username for Stash"
-      $default[:stash_username] = ENV['USER']
-
-      option :stash_password,
-        :short => "-p PASSWORD",
-        :long => "--stash-password PASSWORD",
-        :description => "The password for Stash"
-
-  		option :stash_hostname,
-  			:long => "--stash-hostname HOSTNAME",
-  			:description => "The hostname for Stash"
-
-  	end
-
-    def display_stash_error(message,response)
-      ui.fatal message
-      JSON.parse(response.body)['errors'].each do |error|
-        ui.fatal "#{error['context'] ? error['context'] + ": " : "" }#{error['message']}"
-      end
-    end
-
-    def get_all_values(stash,url,response)
-      r = JSON.parse(response.body)
-      yield r['values']
-      until r['isLastPage']
-        response = stash.get url, { :start => r['nextPageStart'] }
-        r = JSON.parse(response.body)
-        yield r['values']
-      end
-    end
-
-  	def get_config(key)
-  		key = key.to_sym
-  		rval = config[key] || Chef::Config[:knife][key] || $default[key]
-  		Chef::Log.debug("value for config item #{key}: #{rval}")
-  		rval
-  	end
-
-  	def get_stash_connection
-      config[:stash_hostname] = ask("Stash Hostname: ") { |q| q.echo = "*" } unless get_config(:stash_hostname)
-      config[:stash_username] = ask("Stash Username for #{get_config(:stash_hostname)}: ") { |q| q.echo = "*" } unless get_config(:stash_username)
-      config[:stash_password] = ask("Stash Password for #{get_config(:stash_username)}: ") { |q| q.echo = "*" } unless get_config(:stash_password)
-      
-      connection = Faraday.new(:url => "https://#{get_config(:stash_hostname)}", :ssl => {:verify => false}) do |faraday|
-        faraday.request  :url_encoded # form-encode POST params
-        #faraday.response :logger      # log requests to STDOUT
-        faraday.adapter  :net_http    # make requests with Net::HTTP
-      end
-      connection.basic_auth(get_config(:stash_username),get_config(:stash_password))
-      connection.url_prefix = "https://#{get_config(:stash_hostname)}/rest/api/1.0"
-      connection
-  	end
-
-    def get_repo_https_url(project_key,repo)
-      "https://#{get_config(:stash_username)}@#{get_config(:stash_hostname)}/scm/#{project_key}/#{repo}.git"
-    end
-
-    def get_repo_ssh_url(project_key,repo)
-      "ssh://git@#{get_config(:stash_hostname)}:7999/#{project_key}/#{repo}.git"
-    end
-
-  end
-end