woro-gist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 643eaa81aee0d983238690df7c9f3534e43b3f96
+  data.tar.gz: 9856ec3430ac581577ae01578bc7ad05a323b4ed
+SHA512:
+  metadata.gz: ca13de04ae2566f9886e2ad8ea627729de594e535a8d2a95b34b2e1f6cf8d8b40ab9b60e08d2880ffdbb389d5d65a280db0e3c0fd327185c2a01bb0422045257
+  data.tar.gz: d4bec4ab91e623f3d54de8f79c6b63525358dc606e829b29b8377ccca97cea987a1e502e9703fc4a57ecce3bca7f93315ac049dc688c8d96a32ae6bab3ae1d70

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in woro-gist.gemspec
+gemspec
+
+group :test do
+  gem "rspec"
+  gem "rspec-nc"
+  gem 'fakefs'
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    woro-gist (0.0.1)
+      gist
+      woro
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.3.3)
+      highline (~> 1.7.2)
+    diff-lcs (1.2.5)
+    fakefs (0.6.7)
+    gist (4.3.0)
+    highline (1.7.2)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-nc (0.2.0)
+      rspec (>= 2.9)
+      terminal-notifier (>= 1.4)
+    rspec-support (3.3.0)
+    terminal-notifier (1.6.3)
+    woro (0.2.2)
+      commander
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  fakefs
+  rake (~> 10.0)
+  rspec
+  rspec-nc
+  woro-gist!

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daniel Senff
+
+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,41 @@
+# woro-gist
+
+Gist-Adapter for Woro remote task management
+
+Using Github's gist, you keep version control of the tasks and can share them with colleagues.
+
+## Woro adapters
+
+## Usage
+
+
+Once you are done writing the task and you want to execute it on the remote system.
+First you have to push them online, in this case to Gist.
+
+```shell
+$ woro push gist:cleanup_users
+```
+
+_Attention, depending on whether you set up a Gist/Github login on
+initialization. These tasks are online anonymous, but public, or
+private under the specified Github account._
+
+Now, to run a task remotely using Mina, specify the task:
+
+```shell
+$ mina woro:run task=gist:cleanup_users
+```
+
+Or to run it with Capistrano:
+
+```shell
+$ cap woro:run task=gist:cleanup_users
+```
+
+## 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

data/Rakefile

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

data/lib/woro-gist.rb

@@ -0,0 +1,3 @@
+require 'woro'
+require "woro-gist/version"
+require 'woro/adapters/gist'

data/lib/woro-gist/version.rb

@@ -0,0 +1,5 @@
+module Woro
+  module Gist
+    VERSION = "0.0.1"
+  end
+end

data/lib/woro/adapters/gist.rb

@@ -0,0 +1,110 @@
+require 'gist'
+
+module Woro
+  module Adapters
+    class Gist < Base
+      attr_reader :gist_id
+
+      # Setup configuration for adapter
+      # Highline CLI helpers can be used for interactivity.
+      # @return [Hash] Configuration options
+      def self.setup
+        if agree 'Login to Gist/Github for private Woro tasks (Yes/No)?  '
+          ::Gist.login!
+        end
+
+        # create Gist with welcome file
+        # additional tasks will be added to this first gist
+        begin
+          require File.join(Dir.pwd, 'config', 'application.rb')
+          app_name = Rails.application.class.parent_name
+        rescue LoadError
+          app_name = ask('Application name: ')
+        end
+
+        result = create_initial_remote_task(app_name)
+
+        {
+          gist_id: result['id'],
+          public: false
+        }
+      end
+
+      # Create a new gist collection adapter
+      def initialize(options)
+        @gist_id = options['gist_id']
+      end
+
+      # Returns the list of files included in the Gist
+      # @return [Hash] List of files in the format { filename: { data }}
+      def list_files
+        gist['files'].keys
+      end
+
+      # Returns the list of rake files included in the remote collection
+      # with their contents.
+      # @return [Hash] List of files with their contents
+      def list_contents
+        gist['files']
+      end
+
+      # Push this task's file content to the Gist collection on the server.
+      # Existing contents by the same #file_name will be overriden, but
+      # can be accessed via Github or Gist's API.
+      def push(task)
+        ::Gist.multi_gist({ task.file_name => task.read_task_file },
+                        public: false,
+                        update: gist_id,
+                        output: :all)
+      end
+
+      # The raw url is a permalink for downloading the content rake task within
+      # the Gist as a file.
+      # @param file_name [String] name of the file to retrieve the download url
+      # @return [String] HTTP-URL of addressed file within the gist collection
+      def raw_url(file_name)
+        retrieve_file_data(file_name)['raw_url']
+      end
+
+      # Creates an initial welcome gist on project setup
+      # @param app_name [String] Name of the app is displayed in the
+      # initial welcome message
+      def self.create_initial_remote_task(app_name, access_token = nil)
+        ::Gist.gist("Welcome to the Woro Task Repository for #{app_name}",
+                    filename: app_name, access_token: access_token)
+      end
+
+      # Extract description from gist's data content string.
+      # @param data [Hash] gist data hash
+      # [String] description string
+      def extract_description(data)
+        Woro::TaskHelper.extract_description(data['content'])
+      end
+
+      protected
+
+      # The Gist contains a collection of files.
+      # These are stored and accessed on Github.
+      # @return [Hash] parsed JSON hash of the gist's metadata
+      def gist
+        @gist ||= retrieve_gist(gist_id)
+      end
+
+      # Retrieves metadata of the specified gist
+      # @param gist_id [String] id of the gist
+      # @return [Hash] parsed JSON hash
+      def retrieve_gist(gist_id)
+        service_url = "https://api.github.com/gists/#{gist_id}"
+        response = Net::HTTP.get_response(URI.parse(service_url))
+        JSON.parse(response.body || '')
+      end
+
+      # Retrieves the data hash included in the gist under the #file_name.
+      # @param file_name [String] name of the file to retrieve the download url
+      # @return [Hash] parsed JSON hash
+      def retrieve_file_data(file_name)
+        gist['files'][file_name]
+      end
+    end
+  end
+end

data/spec/fixtures/gist.json

@@ -0,0 +1,103 @@
+{
+  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+  "id": "aa5a315d61ae9438b18d",
+  "description": "description of gist",
+  "public": true,
+  "owner": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/octocat",
+    "html_url": "https://github.com/octocat",
+    "followers_url": "https://api.github.com/users/octocat/followers",
+    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+    "organizations_url": "https://api.github.com/users/octocat/orgs",
+    "repos_url": "https://api.github.com/users/octocat/repos",
+    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/octocat/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "user": null,
+  "files": {
+    "create_user.rake": {
+      "size": 932,
+      "raw_url": "https://gist.githubusercontent.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl",
+      "type": "text/plain",
+      "language": "Ruby",
+      "truncated": false,
+      "content": "namespace :woro do\n  desc 'Create User'\n  task create_user: :environment do\n    # Code\n  end\nend\n"
+    }
+  },
+  "comments": 0,
+  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+  "created_at": "2010-04-14T02:15:15Z",
+  "updated_at": "2011-06-20T11:34:15Z",
+  "forks": [
+    {
+      "user": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/octocat",
+        "html_url": "https://github.com/octocat",
+        "followers_url": "https://api.github.com/users/octocat/followers",
+        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+        "organizations_url": "https://api.github.com/users/octocat/orgs",
+        "repos_url": "https://api.github.com/users/octocat/repos",
+        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/octocat/received_events",
+        "type": "User",
+        "site_admin": false
+      },
+      "url": "https://api.github.com/gists/dee9c42e4998ce2ea439",
+      "id": "dee9c42e4998ce2ea439",
+      "created_at": "2011-04-14T16:00:49Z",
+      "updated_at": "2011-04-14T16:00:49Z"
+    }
+  ],
+  "history": [
+    {
+      "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f",
+      "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",
+      "user": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/octocat",
+        "html_url": "https://github.com/octocat",
+        "followers_url": "https://api.github.com/users/octocat/followers",
+        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+        "organizations_url": "https://api.github.com/users/octocat/orgs",
+        "repos_url": "https://api.github.com/users/octocat/repos",
+        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/octocat/received_events",
+        "type": "User",
+        "site_admin": false
+      },
+      "change_status": {
+        "deletions": 0,
+        "additions": 180,
+        "total": 180
+      },
+      "committed_at": "2010-04-14T02:15:15Z"
+    }
+  ]
+}

data/spec/lib/woro/adapters/gist_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'json'
+
+describe Woro::Adapters::Gist do
+
+  let!(:gist_id) { rand(999)}
+  let(:task) { Woro::Task.new('create_user') }
+  subject { Woro::Adapters::Gist.new(gist_id: gist_id) }
+  let(:gist_hash) do
+    FakeFS.deactivate!
+    body = File.read(File.join('spec', 'fixtures', 'gist.json'))
+    FakeFS.activate!
+    JSON.parse(body)
+  end
+
+  before do
+    allow(subject).to receive(:gist).once.and_return gist_hash
+  end
+
+  describe '#list_files' do
+    it 'returns list' do
+      expect(subject.list_files).to match ['create_user.rake']
+    end
+  end
+
+  describe '#list_contents' do
+    it 'returns list' do
+      expected_data = {
+        'create_user.rake' => {
+          "size" => 932,
+          "raw_url" => "https://gist.githubusercontent.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl",
+          "type" => "text/plain",
+          "language" => "Ruby",
+          "truncated" => false,
+          "content" => "namespace :woro do\n  desc 'Create User'\n  task create_user: :environment do\n    # Code\n  end\nend\n"
+        }
+      }
+      expect(subject.list_contents).to eq expected_data
+    end
+  end
+
+  describe '#push' do
+    it 'calls gist services with correct params' do
+      File.open(task.file_path, 'w') do |f|
+        f.puts 'hey'
+      end
+      expected_files_hash = { task.file_name => task.read_task_file }
+      expected_params_hash = { public: false,
+                               update: gist_id,
+                               output: :all
+                              }
+      expect(::Gist).to receive(:multi_gist)
+        .with(expected_files_hash, expected_params_hash)
+        .and_return gist_hash
+      subject.push(task)
+    end
+  end
+
+  describe '#retrieve_file_data' do
+    it 'returns data hash from file' do
+      expected_hash = {
+        "size" => 932,
+        "raw_url" => "https://gist.githubusercontent.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl",
+        "type" => "text/plain",
+        "language" => "Ruby",
+        "truncated" => false,
+        "content" => "namespace :woro do\n  desc 'Create User'\n  task create_user: :environment do\n    # Code\n  end\nend\n"
+      }
+      expect(subject.send(:retrieve_file_data, 'create_user.rake')).to eq expected_hash
+    end
+  end
+
+  describe '#raw_url' do
+    it 'returns raw_url of file' do
+      expected_url = "https://gist.githubusercontent.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl"
+      expect(subject.raw_url('create_user.rake')).to eq expected_url
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'woro'
+require 'woro-gist'
+require 'fakefs/safe'
+
+Dir[('./spec/support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = 'random'
+
+  config.before(:each) do
+    FakeFS.activate!
+    FileUtils.mkdir_p 'config'
+    FileUtils.mkdir_p 'lib/woro_tasks'
+    FileUtils.mkdir_p 'lib/tasks'
+  end
+end
+

data/woro-gist.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'woro-gist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "woro-gist"
+  spec.version       = Woro::Gist::VERSION
+  spec.authors       = ["Daniel Senff"]
+  spec.email         = ["mail@danielsenff.de"]
+  spec.summary       = %q{Adapter to Github's Gist for use in Woro remote task management}
+  spec.description   = %q{Adapter to Github's Gist for use in Woro remote task management}
+  spec.homepage      = "http://github.com/Dahie/woro-gist"
+  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 "gist"
+  spec.add_dependency "woro"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: woro-gist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Senff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: woro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: Adapter to Github's Gist for use in Woro remote task management
+email:
+- mail@danielsenff.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/woro-gist.rb
+- lib/woro-gist/version.rb
+- lib/woro/adapters/gist.rb
+- spec/fixtures/gist.json
+- spec/lib/woro/adapters/gist_spec.rb
+- spec/spec_helper.rb
+- woro-gist.gemspec
+homepage: http://github.com/Dahie/woro-gist
+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.6
+signing_key: 
+specification_version: 4
+summary: Adapter to Github's Gist for use in Woro remote task management
+test_files:
+- spec/fixtures/gist.json
+- spec/lib/woro/adapters/gist_spec.rb
+- spec/spec_helper.rb