travis-custom-deploy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aec931f741eed8f077825a3befa8466e5e4976f6
-  data.tar.gz: 5532a7c0308adc31324907698f77c67ed1161236
+  metadata.gz: 76a456e9755c9e0f605bf5284750ff4143d3fac9
+  data.tar.gz: 3db5ba20e932a1139ca16258f764ba6f3b1fe91b
 SHA512:
-  metadata.gz: 520ad562cd94147e07f0f61e91f5b9ab6ea096624a4c5d04d024e32d3b5bc0fdc867b34012208fa4a426a4cbeccefac062e2dcc989a134e293f4eab62af025f0
-  data.tar.gz: 265c9efffe93c98e2bff80db8e516fa165a9a6a3464a71b4cb0959b449443e9a619eab071f216055404779d16496f4d1cb8af907f8ea4f96ef5887f9f84ae835
+  metadata.gz: 6d08feb91cd3845d41ccf3ed034d174d7f80e41b9ab908b0d2b6d41e3e1623adfb1c645cbf100657c94ba644c6f5e020d4132c6b4f3e4e274fd95aa3e1416c88
+  data.tar.gz: 0bf6ac51455bd1aca593e72dbbeaac76f872c349f498fe37b64bdea8bb4dbe00ca254f2c6ae3b418d2d3b4f0189702dd64bef34c0ac1585e8fee9e33222803d3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+before_install:
+  - gem install bundler
+rvm:
+  - 2.1.0
+script: bundle exec rake

data/LICENSE.md

@@ -0,0 +1,23 @@
+
+The MIT License
+===============
+
+Copyright (c) 2013, Jens Nazarenus
+
+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

@@ -1,8 +1,17 @@
-travis-custom-deploy
+travis-custom-deploy [![Gem Version](https://badge.fury.io/rb/travis-custom-deploy.png)](http://badge.fury.io/rb/travis-custom-deploy) 
 ====================
+ [![Build Status](https://travis-ci.org/jens-na/travis-custom-deploy.png?branch=master)](https://travis-ci.org/jens-na/travis-custom-deploy) [![Coverage Status](https://coveralls.io/repos/jens-na/travis-custom-deploy/badge.png?branch=master)](https://coveralls.io/r/jens-na/travis-custom-deploy?branch=master)
+ [![Dependency Status](https://gemnasium.com/jens-na/travis-custom-deploy.png)](https://gemnasium.com/jens-na/travis-custom-deploy)
 
 Deploy your ruby based applications on your own server.
 
+Configuration
+-------------
+You need to define environment variables with Travis. `travis-custom-deploy` will use those to 
+deploy your application.
+
+Example:
+```yml
 env:
   global:
     - "CUSTOM_DEPLOY_HOST=host"
@@ -10,4 +19,25 @@ env:
     - "CUSTOM_DEPLOY_PASSWORD=password"
     - "CUSTOM_DEPLOY_REMOTEDIR=/path/to/"
 
-travis-custom-deploy sftp site/ 
+after_success: travis-custom-deploy sftp _site/
+```
+
+#### Services
+There are predefined services available. For example if you want to deploy a [Jekyll](https://github.com/jekyll/jekyll) page you can write:
+
+```yml
+after_success: travis-custom-deploy sftp service:jekyll
+```
+
+Services currently availble:
+```
+Service  File
+-------- -------
+jekyll   _site/
+```
+
+License and Copyright
+=====================
+Licensed under the MIT license. 
+
+Jens Nazarenus, 2014

data/bin/travis-custom-deploy

@@ -6,25 +6,26 @@ def usage
   puts 'Usage: travis-custom-deploy TRANSFER_TYPE FILES...'
 end
 
+# Returns a list of read environment variables in a hash based
+# on options.rb. The hash may be used as parameter for deployment.rb.
+def get_env_vars(transfer_type)
+  envs = TravisCustomDeploy::Options.get_options(transfer_type)
+  options = {}
+  for e in envs
+    value = ENV['DEPLOY_' + e.upcase]
+    options[e] = value
+  end
+  options
+end
+
 if ARGV.count < 2
   usage 
 end
 
-transfer = ARGV[0]
+transfer_type = ARGV[0]
 files = ARGV[1..-1]
 
-host = ENV['DEPLOY_HOST']
-username = ENV['DEPLOY_USERNAME']
-password = ENV['DEPLOY_PASSWORD']
-remotedir = ENV['DEPLOY_REMOTEDIR']
-
-transfer_opts = {
-  :type => transfer,
-  :host => ENV['DEPLOY_HOST'],
-  :username => ENV['DEPLOY_USERNAME'],
-  :password => ENV['DEPLOY_PASSWORD'],
-  :remotedir => ENV['DEPLOY_REMOTEDIR']
-}
+options = get_env_vars(transfer_type)
 
-d = TravisCustomDeploy::Deployment.new(transfer_opts, files)
+d = TravisCustomDeploy::Deployment.new(transfer_type, options, files)
 d.deploy

data/lib/travis-custom-deploy.rb

@@ -1,5 +1,5 @@
 require 'travis-custom-deploy/deployment'
 require 'travis-custom-deploy/transfer'
 require 'travis-custom-deploy/version'
-require 'travis-custom-deploy/services'
+require 'travis-custom-deploy/options'
 require 'travis-custom-deploy/transfer/base'

data/lib/travis-custom-deploy/deployment.rb

@@ -2,39 +2,33 @@ module TravisCustomDeploy
 
   class Deployment
 
-    attr_reader :remoteopts
+    attr_reader :options
     attr_reader :files
 
-    def initialize(remoteopts, files)
-      check_remoteopts(remoteopts)
-      @remoteopts = remoteopts
+    # Initializes a new deployment
+    #
+    # remteopts - the options to connect to the remote server
+    # files - the files to transfer
+    def initialize(transfer_type, options, files)
+      raise ArgumentError, 'transfer type must not be nil' if transfer_type.nil?
       @files = files
       check_services(@files[0])
-      @transfer = get_transfer(remoteopts[:type])
+      @options = options
+      @transfer = get_transfer(transfer_type)
     end
 
-    # Actually start the deployment
+    # Starts the deployment
     def deploy
       @transfer.transfer
     end
 
-    # Check if the remoteopts are valid
-    #
-    # opts - the remote opts to check
-    def check_remoteopts(opts)
-      raise ArgumentError, 'host must not be nil' if opts[:host].nil?
-      raise ArgumentError, 'username must not be nil' if opts[:username].nil?
-      raise ArgumentError, 'password must not be nil' if opts[:password].nil?
-      raise ArgumentError, 'transfer type must not be nil' if opts[:type].nil?
-    end
-
-    # Create an instance for the transfer type and return it 
+    # Creates an instance for the transfer type and return it 
     #
     # type - the transfer type like sftp, ftp, etc.
     def get_transfer(type)
       type = type[0].upcase + type[1..-1]
       try_require(type)
-      Transfer.const_get(type).new(@remoteopts, @files) 
+      Transfer.const_get(type).new(@options, @files) 
     end
 
     # Try requiring a transfer type class 
@@ -46,7 +40,7 @@ module TravisCustomDeploy
     end
     protected :try_require
 
-    # check if the first file matches service:<service-name>
+    # Check if the first file matches service:<service-name>
     # and try to determine the files based on the service.
     #
     # first_file the first file given

data/lib/travis-custom-deploy/options.rb

@@ -0,0 +1,46 @@
+module TravisCustomDeploy
+
+  # The available services. Each service has an
+  # unique id and an array of files or directories to deploy.
+  SERVICES = {
+
+    # Jekyll support
+    # Usage: service:jekyll
+    'jekyll' => [ '_site/' ]
+  }
+
+  # The possible options of the different transfer types
+  OPTIONS = {
+
+    'sftp' => [ 
+      'host',        # host name of the sftp server
+      'username',    # username to connect
+      'password',    # password to connect
+      'remotedir'    # remote dir, for example: /public/
+    ],
+
+    'ftp' => [
+      'host',        # host name of the ftp server      
+      'username',    # username to connect
+      'password',    # password to connect
+      'remotedir'    # remote dir, for example: /public/
+    ],
+
+    'copy' => [
+      'remotedir'    # the destination where to copy the files 
+    ]
+
+  }
+
+  class Options
+
+    def self.get_options(transfer_type)
+      OPTIONS.each do |k,v|
+        if k == transfer_type
+          return v
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/travis-custom-deploy/transfer.rb

@@ -4,6 +4,7 @@ module TravisCustomDeploy
 
     autoload :Sftp, 'travis-custom-deploy/transfer/sftp'
     autoload :Ftp, 'travis-custom-deploy/transfer/ftp'
+    autoload :Copy, 'travis-custom-deploy/transfer/copy'
 
   end
 

data/lib/travis-custom-deploy/transfer/base.rb

@@ -4,13 +4,13 @@ module TravisCustomDeploy
 
     class Base
 
-      attr_reader :remoteopts
+      attr_reader :options
       attr_reader :files
 
-      def initialize(remoteopts, files)
-        @remoteopts = remoteopts
+      def initialize(options, files)
+        @options = options
         @files = files
-        prepare_remotedir
+        check_options(options)
       end
 
       # The method which needs to be implemented by subclasses
@@ -19,12 +19,13 @@ module TravisCustomDeploy
         raise NotImplementedError 
       end
 
-      # Prepares the remote directory (remote trailing slash)
-      def prepare_remotedir
-        @remotedir = @remoteopts[:remotedir]
-        @remotedir = "" if @remotedir.nil?
-        @remotedir = @remotedir[0..-2] if @remotedir[-1] == "/"
+      # The method which needs to be implemented by subclasses
+      # to check if the remote options are sufficient for the
+      # defined transfer type
+      def check_options
+        raise NotImplementedError
       end
+
     end
   end
 end

data/lib/travis-custom-deploy/transfer/copy.rb

@@ -0,0 +1,12 @@
+module TravisCustomDeploy
+
+  module Transfer
+
+    class Copy < Base
+
+      def initialize
+        super(@remoteopts, files)
+      end
+    end
+  end
+end

data/lib/travis-custom-deploy/transfer/ftp.rb

@@ -0,0 +1,17 @@
+module TravisCustomDeploy
+
+  module Transfer
+
+    # The class which transfers files via the File Transfer protocol (FTP).
+    class Ftp < Base
+
+      def initialize(remoteopts, files)
+        super(remoteopts, files)
+      end
+
+      def transfer
+        
+      end
+    end
+  end
+end

data/lib/travis-custom-deploy/transfer/sftp.rb

@@ -4,22 +4,37 @@ module TravisCustomDeploy
 
   module Transfer
 
+    # The class which transfers files via the SSH File Transfer Protocol
+    # (SFTP). 
     class Sftp < Base
 
-      def initialize(remoteopts, files)
-        super(remoteopts, files)
+      def initialize(options, files)
+        super(options, files)
+        prepare_remotedir
       end
 
-      # transfers the given files via sftp
       def transfer
-        Net::SFTP.start(@remoteopts[:host], @remoteopts[:username], :password => @remoteopts[:password]) do |sftp|
+        Net::SFTP.start(@options['host'], @options['username'], 
+                        :password => @options['password']) do |sftp|
           for e in @files
             sftp.upload!(e, "#{@remotedir}/")
           end
         end
       end
 
+      def check_options(options)
+        raise ArgumentError, 'host name must not be nil' if options['host'].nil?
+        raise ArgumentError, 'username must not be nil' if options['username'].nil?
+        raise ArgumentError, 'password must not be nil' if options['password'].nil?
+      end
 
+      # Prepares the remote directory (remote trailing slash)
+      def prepare_remotedir
+        @remotedir = @options[:remotedir]
+        @remotedir = "" if @remotedir.nil?
+        @remotedir = @remotedir[0..-2] if @remotedir[-1] == "/"
+      end
+      
     end
   end
 end

data/lib/travis-custom-deploy/version.rb

@@ -1,5 +1,5 @@
 module TravisCustomDeploy
 
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
 end

data/test/test_deployment.rb

@@ -5,17 +5,16 @@ class TestDeployment < Test::Unit::TestCase
   context "A deployment" do
     setup do
       @opts = {
-        :type => 'sftp',
-        :host => 'example.org',
-        :username => 'username',
-        :password => 'password',
-        :remotedir => '/public/'
+        'host' => 'example.org',
+        'username' => 'username',
+        'password' => 'password',
+        'remotedir' => '/public/'
       }
     end
 
     context "with files" do
       setup do
-        @deployment = Deployment.new(@opts, ['foo', 'bar', 'foo2'])
+        @deployment = Deployment.new('sftp', @opts, ['foo', 'bar', 'foo2'])
       end
 
       should "return file names" do
@@ -25,7 +24,7 @@ class TestDeployment < Test::Unit::TestCase
 
     context "with service identifier as first file name" do
       setup do
-        @deployment = Deployment.new(@opts, ['service:jekyll'])
+        @deployment = Deployment.new('sftp', @opts, ['service:jekyll'])
       end
 
       should "return file names of service" do

data/test/test_options.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestOptions < Test::Unit::TestCase
+
+  context "Options" do
+
+    context "environment variables" do
+      setup do
+        @env = Options.get_options('sftp') 
+      end
+
+      should "return sftp options" do
+        assert_equal ['host', 'username', 'password', 'remotedir'], @env
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: travis-custom-deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jens Nazarenus
@@ -159,6 +159,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -168,14 +169,16 @@ files:
 - features/.gitkeep
 - lib/travis-custom-deploy.rb
 - lib/travis-custom-deploy/deployment.rb
-- lib/travis-custom-deploy/services.rb
+- lib/travis-custom-deploy/options.rb
 - lib/travis-custom-deploy/transfer.rb
 - lib/travis-custom-deploy/transfer/base.rb
+- lib/travis-custom-deploy/transfer/copy.rb
 - lib/travis-custom-deploy/transfer/ftp.rb
 - lib/travis-custom-deploy/transfer/sftp.rb
 - lib/travis-custom-deploy/version.rb
 - test/helper.rb
 - test/test_deployment.rb
+- test/test_options.rb
 - travis-custom-deploy.gemspec
 homepage: https://github.com/jens-na/travis-custom-deploy
 licenses:
@@ -205,3 +208,4 @@ test_files:
 - features/.gitkeep
 - test/helper.rb
 - test/test_deployment.rb
+- test/test_options.rb

data/lib/travis-custom-deploy/services.rb

@@ -1,10 +0,0 @@
-module TravisCustomDeploy
-
-  SERVICES = {
-  
-    'jekyll' => [ '_site/' ]
-
-    # future services
-  }
-
-end