xploy 0.1.0.beta

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jens Bissinger
+
+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,67 @@
+# xploy
+
+[appway](http://github.com/threez/appway) client written in ruby
+
+[![Gem Version](https://badge.fury.io/rb/xploy.png)](https://rubygems.org/gems/xploy)
+[![Travis-CI Build Status](https://secure.travis-ci.org/dpree/xploy.png)](https://travis-ci.org/dpree/xploy)
+[![Coverage Status](https://coveralls.io/repos/dpree/xploy/badge.png)](https://coveralls.io/r/dpree/xploy)
+[![Dependency Status](https://gemnasium.com/dpree/xploy.png)](https://gemnasium.com/dpree/xploy)
+[![Code Climate](https://codeclimate.com/github/dpree/xploy.png)](https://codeclimate.com/github/dpree/xploy)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xploy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xploy
+
+## Usage
+
+    $ xploy
+
+### Recommended config settings
+
+You can store default parameters like `app.name` and `app.manifest` in a file named `.xploy` located in your current working dir.
+
+For an example just have a look at the `appway-example` folder.
+
+    $ cd appway-example
+
+Here you can just redeploy the preconfigured app like so:
+
+    $ xploy redeploy
+
+## Development
+
+To run the binary from the repository use the following command with ruby libray path:
+
+    RUBYLIB=lib bin/xploy
+
+### Coding guide
+
+* Using global methods like `Xploy.parameter`
+  * is allowed for classes / modules defined on the same or a higher level to the `Xploy` namespace
+  * is allowed for classes / modules defined excactly one level below the `Xploy` namespace
+    * e.g. `Xploy::Api`
+  * is not allowed for classes / modules defined more than one level below the `Xploy` namespace
+    * e.g. `Xploy::Api::Request`
+    * these classes should use dependency injection instead
+
+### Contributing
+
+1. Fork it
+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 new Pull Request
+
+# License
+
+Copyright (c) 2013 Jens Bissinger. See [LICENSE.txt](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/appway-example/.xploy

@@ -0,0 +1,3 @@
+app:
+  name: example
+  manifest: appway-example.json

data/appway-example/appway-example.json

@@ -0,0 +1,21 @@
+{
+  "name": "example",
+  "repo": {
+    "url": "git://github.com/threez/appway-example.git",
+    "branch": "master"
+  },
+  "packages": {
+  },
+  "user": "www-data",
+  "group": "www-data",
+  "domain": [
+    "^example.*",
+    "^example.local$"
+  ],
+  "install": [
+    "npm install"
+  ],
+  "scale": {
+    "web": 2
+  }
+}

data/bin/xploy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'xploy'
+Xploy::Cli.new.start

data/lib/xploy/api/endpoints.rb

@@ -0,0 +1,76 @@
+module Xploy
+  class Api
+    class Endpoints
+      def list options={}
+        Request.new 'get', '/applications'
+      end
+
+      def create options={}
+        Request.new 'post', '/applications', options
+      end
+
+      def find options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'get', "/applications/#{options[:name]}"
+      end
+
+      def update options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'put', "/applications/#{options[:name]}"
+      end
+
+      def delete options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'delete', "/applications/#{options[:name]}"
+      end
+
+      def log options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'get', "/applications/#{options[:name]}/log"
+      end
+
+      def start options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'post', "/applications/#{options[:name]}/start"
+      end
+
+      def stop options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'post', "/applications/#{options[:name]}/stop"
+      end
+
+      def restart options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'post', "/applications/#{options[:name]}/restart"
+      end
+
+      def redeploy options={}
+        require_options options, :name
+        options[:name] ||= ':name'
+        Request.new 'post', "/applications/#{options[:name]}/redeploy"
+      end
+
+    private
+
+      def require_options options, *keys
+        missing_keys = []
+        keys.each do |key|
+          if !options.is_a?(Hash) || options[key] == nil || options[key] == ''
+            missing_keys << key
+          end
+        end
+        unless missing_keys.empty?
+          raise MissingParameter, "Missing app parameter(s): "\
+                                  "#{missing_keys.map(&:to_s).join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/xploy/api/http.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+
+module Xploy
+  class Api
+    class Http
+      def request server, request, debug=false
+        uri = File.join(server, request.path)
+        http_options = request.http_options.tap do |http_options|
+          http_options[:debug_output] = STDOUT if debug
+        end
+        HTTParty.send(request.method_name, uri, http_options)
+      rescue => e
+        raise ConnectionError, ["#{server} appears offline", e]
+      end
+    end
+  end
+end

data/lib/xploy/api/request/body.rb

@@ -0,0 +1,41 @@
+module Xploy
+  class Api
+    class Request
+      class Body
+        attr_reader :path
+
+        def initialize path
+          @path = path
+        end
+
+        def read
+          check_type do |extname|
+            if File.exists?(path)
+              File.read(path)
+            else
+              raise ManifestFileNotFound, "could not find file #{path}"
+            end
+          end
+        end
+
+        def mime_type
+          check_type do |extname|
+            'application/json'
+          end
+        end
+
+      private
+
+        def check_type
+          extname = File.extname(path)
+          if extname == '.json'
+            yield extname
+          else
+            raise ManifestFileTypeUnsupported, \
+              "unsupported extension #{extname} for #{path}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xploy/api/request.rb

@@ -0,0 +1,37 @@
+require 'xploy/api/request/body'
+
+module Xploy
+  class Api
+    class Request
+      attr_reader :method_name, :path, :headers, :body
+
+      def initialize method_name, path, options={}
+        @method_name = method_name
+        @path = path
+        @options = options
+        @body = build_body
+        @headers = build_headers
+      end
+
+      def build_headers
+        {'X-App' => 'appway'}.tap do |headers|
+          headers['Content-Type'] = body.mime_type if body
+        end
+      end
+
+      def build_body
+        if path = @options[:manifest]
+          @body = Body.new path
+        else
+          @body = nil
+        end
+      end
+
+      def http_options
+        http_options = {headers: headers}.tap do |http_options|
+          http_options[:body] = body.read if body
+        end
+      end
+    end
+  end
+end

data/lib/xploy/api.rb

@@ -0,0 +1,25 @@
+require 'xploy/api/request'
+require 'xploy/api/endpoints'
+require 'xploy/api/http'
+
+module Xploy
+  class Api
+    def request method_name, *args, &block
+      http = Http.new
+      request = build_request method_name
+      parameter[:servers].map do |server|
+        http.request server, request, parameter[:debug]
+      end
+    end
+
+  private
+
+    def parameter
+      Xploy.parameter
+    end
+
+    def build_request method_name
+      Endpoints.new.send(method_name, parameter[:app] || {})
+    end
+  end
+end

data/lib/xploy/cli.rb

@@ -0,0 +1,21 @@
+module Xploy
+  class Cli
+    def initialize api=Api.new, out=STDOUT
+      @api = api
+      @out = out
+    end
+
+    def start
+      commands = Xploy.parameter.rest
+      if Xploy.parameter[:version]
+        @out.puts "xploy #{VERSION}"
+      elsif commands.empty?
+        Xploy.parameter.print_help!
+      else
+        @out.puts @api.request(*commands)
+      end
+    rescue MissingParameter => e
+      @out.puts e.message
+    end
+  end
+end

data/lib/xploy/error.rb

@@ -0,0 +1,11 @@
+module Xploy
+  # global error class
+  class Error < StandardError; end
+
+  class ManifestFileNotFound < Error; end
+  class ManifestFileTypeUnsupported < Error; end
+
+  class MissingParameter < Error; end
+
+  class ConnectionError < Error; end
+end

data/lib/xploy/parameter.rb

@@ -0,0 +1,66 @@
+require 'configliere'
+
+module Xploy
+  class Parameter
+    def reload!
+      @param = Configliere::Param.new
+      @param.define :servers,       type: Array,
+                                    flag: 's',
+                                    description: 'all appway servers',
+                                    default: ['http://localhost:8000']
+      @param.define 'app.name',     flag: 'a',
+                                    description: 'name of your app'
+      @param.define 'app.manifest', flag: 'm',
+                                    description: 'path to your app.way file'
+      @param.define :debug,         flag: 'd',
+                                    description: 'print debug info to stdout',
+                                    default: false
+      @param.define :version,       flag: 'v',
+                                    description: 'print version info'
+      @param.read global_config if File.exists? global_config
+      @param.read local_config if File.exists? local_config
+      @param.use(:commandline)
+      @param.resolve!
+      self
+    end
+
+    def print_help!
+      reload!
+      @param[:help] = true
+      @param.resolve!
+      self
+    end
+
+    def [] key
+      if @param
+        @param[key]
+      else
+        nil
+      end
+    end
+
+    def rest
+      if @param
+        @param.rest
+      else
+        []
+      end
+    end
+
+    def to_hash
+      if @param
+        @param.to_hash
+      else
+        {}
+      end
+    end
+
+    def global_config
+      ENV['XPLOY_CONFIG'] || File.join(ENV['HOME'], '.xploy')
+    end
+
+    def local_config
+      File.join(Dir.pwd, '.xploy')
+    end
+  end
+end

data/lib/xploy/version.rb

@@ -0,0 +1,3 @@
+module Xploy
+  VERSION = "0.1.0.beta"
+end

data/lib/xploy.rb

@@ -0,0 +1,11 @@
+require 'xploy/version'
+require 'xploy/error'
+require 'xploy/parameter'
+require 'xploy/api'
+require 'xploy/cli'
+
+module Xploy
+  def self.parameter
+    @parameter ||= Parameter.new.reload!
+  end
+end

data/spec/assets/appway-example.json

@@ -0,0 +1,21 @@
+{
+  "name": "example",
+  "repo": {
+    "url": "git://github.com/threez/appway-example.git",
+    "branch": "master"
+  },
+  "packages": {
+  },
+  "user": "www-data",
+  "group": "www-data",
+  "domain": [
+    "^example.*",
+    "^example.local$"
+  ],
+  "install": [
+    "npm install"
+  ],
+  "scale": {
+    "web": 2
+  }
+}

data/spec/assets/custom.xway

@@ -0,0 +1 @@
+foo: bar

data/spec/integration/bin/xploy_binary_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'open3'
+require 'xploy/version'
+
+class XployBinary
+  attr_reader :stdin, :stdout, :stderr
+  def run
+    exe = File.expand_path('../../../bin/xploy', File.dirname(__FILE__))
+    ENV['RUBYLIB'] = File.join(File.dirname(__FILE__), '../../../lib')
+    @stdin, @stdout, @stderr = Open3.popen3("#{exe} --version")
+  end
+end
+
+describe XployBinary do
+  before { subject.run }
+  its('stderr.readlines.to_s') { should_not include('xploy') }
+  its('stdout.readlines.to_s') { should include(Xploy::VERSION) }
+end

data/spec/integration/lib/xploy/cli_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'xploy'
+
+describe Xploy::Cli do
+  it 'uses api and stdout per default' do
+    subject.instance_variable_get('@api').should be_instance_of(Xploy::Api)
+    subject.instance_variable_get('@out').should eq STDOUT
+  end
+end

data/spec/lib/xploy/api/endpoints_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'xploy/error'
+require 'xploy/api/endpoints'
+require 'xploy/api/request'
+
+describe Xploy::Api::Endpoints do
+  subject('endpoints') { described_class.new }
+
+  specify 'list doesnt require_options' do
+    expect{ subject.list }.not_to raise_error(Xploy::MissingParameter)
+  end
+  specify 'create doesnt require_options' do
+    expect{ subject.create }.not_to raise_error(Xploy::MissingParameter)
+  end
+  specify 'find does require_options' do
+    expect{ subject.find }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'update does require_options' do
+    expect{ subject.update }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'delete does require_options' do
+    expect{ subject.delete }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'log does require_options' do
+    expect{ subject.log }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'start does require_options' do
+    expect{ subject.start }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'stop does require_options' do
+    expect{ subject.stop }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'restart does require_options' do
+    expect{ subject.restart }.to raise_error(Xploy::MissingParameter)
+  end
+  specify 'redeploy does require_options' do
+    expect{ subject.redeploy }.to raise_error(Xploy::MissingParameter)
+  end
+
+  context 'mock require_options' do
+    before { endpoints.stub('require_options') }
+
+    describe 'list' do
+      subject            { endpoints.list({}) }
+      its('method_name') { should eq 'get' }
+      its('path')        { should eq '/applications' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'create' do
+      let('manifest')    { File.join(ASSETS_PATH, 'appway-example.json') }
+      subject            { endpoints.create manifest: manifest }
+      its('method_name') { should eq 'post' }
+      its('path')        { should eq '/applications' }
+      its('headers')     { should eq('X-App' => 'appway',
+                                     'Content-Type' => 'application/json') }
+      its('body')        { should be_kind_of(Xploy::Api::Request::Body) }
+    end
+
+    describe 'find' do
+      subject            { endpoints.find name: 'foo' }
+      its('method_name') { should eq 'get' }
+      its('path')        { should eq '/applications/foo' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'update' do
+      subject            { endpoints.update name: 'foo' }
+      its('method_name') { should eq 'put' }
+      its('path')        { should eq '/applications/foo' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'delete' do
+      subject            { endpoints.delete name: 'foo' }
+      its('method_name') { should eq 'delete' }
+      its('path')        { should eq '/applications/foo' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'log' do
+      subject            { endpoints.log name: 'foo' }
+      its('method_name') { should eq 'get' }
+      its('path')        { should eq '/applications/foo/log' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'start' do
+      subject            { endpoints.start name: 'foo' }
+      its('method_name') { should eq 'post' }
+      its('path')        { should eq '/applications/foo/start' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'stop' do
+      subject            { endpoints.stop name: 'foo' }
+      its('method_name') { should eq 'post' }
+      its('path')        { should eq '/applications/foo/stop' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'restart' do
+      subject            { endpoints.restart name: 'foo' }
+      its('method_name') { should eq 'post' }
+      its('path')        { should eq '/applications/foo/restart' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+
+    describe 'redeploy' do
+      subject            { endpoints.redeploy name: 'foo' }
+      its('method_name') { should eq 'post' }
+      its('path')        { should eq '/applications/foo/redeploy' }
+      its('headers')     { should eq('X-App' => 'appway') }
+      its('body')        { should eq(nil) }
+    end
+  end
+end