pushpop-github 0.1.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+
+rvm:
+  - 2.1.1
+
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'pushpop'
+gem 'github_api'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'debugger'
+  gem 'mail'
+  gem 'twilio-ruby'
+end

data/Gemfile.lock

@@ -0,0 +1,94 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    clockwork (0.7.5)
+      activesupport
+      tzinfo
+    columnize (0.3.6)
+    debugger (1.6.6)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.2)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.0.0)
+    i18n (0.6.9)
+    json (1.8.1)
+    jwt (1.0.0)
+    keen (0.8.2)
+      addressable (~> 2.3.5)
+      multi_json (~> 1.3)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    polyglot (0.3.4)
+    pushpop (0.1.0)
+      clockwork
+      keen
+    rack (1.5.2)
+    rake (10.3.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    thread_safe (0.3.4)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    twilio-ruby (3.11.5)
+      builder (>= 2.1.2)
+      jwt (>= 0.1.2)
+      multi_json (>= 1.3.0)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  github_api
+  mail
+  pushpop
+  rake
+  rspec
+  twilio-ruby

data/LICENSE

@@ -0,0 +1,21 @@
+Author Josh Dzielak
+Copyright (c) 2014 Keen Labs
+
+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,178 @@
+## pushpop-github
+
+[![Build Status](https://travis-ci.org/pushpop-project/pushpop-github.svg)](https://travis-ci.org/pushpop-project/pushpop-github)
+
+Github API integration for [Pushpop](https://github.com/keenlabs/pushpop).
+
+### Installation
+
+Add the `pushpop-github` gem to your Gemfile:
+
+``` ruby
+gem 'pushpop-github'
+```
+
+or install it locally:
+
+``` shell
+$ gem install pushpop-github
+```
+
+### Usage
+
+Here's a simple that job defines a `github` step, setting a `user` and `repository`:
+
+``` ruby
+require 'pushpop-github'
+
+job do
+
+  github do
+    user       'keenlabs'
+    repository 'pushpop'
+  end
+
+  step do |repository, _|
+    puts "keenlabs/pushpop has #{repository.stargazers_count} stars!"
+  end
+
+end
+```
+
+The `github` step pulls repository information from the Github API and passes it on to
+the next step.
+
+##### Repository fields
+
+Here's what repository data looks like, using the main Pushpop repository as an example:
+
+``` json
+{
+  "id": 18272447,
+  "name": "pushpop",
+  "full_name": "keenlabs/pushpop",
+  "owner": {
+    "login": "keenlabs",
+    "id": 1315418,
+    "avatar_url": "https://avatars.githubusercontent.com/u/1315418?",
+    "gravatar_id": "b948c4bc2de9618c488431612d2ff99d",
+    "url": "https://api.github.com/users/keenlabs",
+    "html_url": "https://github.com/keenlabs",
+    "followers_url": "https://api.github.com/users/keenlabs/followers",
+    "following_url": "https://api.github.com/users/keenlabs/following{/other_user}",
+    "gists_url": "https://api.github.com/users/keenlabs/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/keenlabs/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/keenlabs/subscriptions",
+    "organizations_url": "https://api.github.com/users/keenlabs/orgs",
+    "repos_url": "https://api.github.com/users/keenlabs/repos",
+    "events_url": "https://api.github.com/users/keenlabs/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/keenlabs/received_events",
+    "type": "Organization",
+    "site_admin": false
+  },
+  "private": false,
+  "html_url": "https://github.com/keenlabs/pushpop",
+  "description": "Send alerts and recurring reports based on Keen IO events",
+  "fork": false,
+  "url": "https://api.github.com/repos/keenlabs/pushpop",
+  "forks_url": "https://api.github.com/repos/keenlabs/pushpop/forks",
+  "keys_url": "https://api.github.com/repos/keenlabs/pushpop/keys{/key_id}",
+  "collaborators_url": "https://api.github.com/repos/keenlabs/pushpop/collaborators{/collaborator}",
+  "teams_url": "https://api.github.com/repos/keenlabs/pushpop/teams",
+  "hooks_url": "https://api.github.com/repos/keenlabs/pushpop/hooks",
+  "issue_events_url": "https://api.github.com/repos/keenlabs/pushpop/issues/events{/number}",
+  "events_url": "https://api.github.com/repos/keenlabs/pushpop/events",
+  "assignees_url": "https://api.github.com/repos/keenlabs/pushpop/assignees{/user}",
+  "branches_url": "https://api.github.com/repos/keenlabs/pushpop/branches{/branch}",
+  "tags_url": "https://api.github.com/repos/keenlabs/pushpop/tags",
+  "blobs_url": "https://api.github.com/repos/keenlabs/pushpop/git/blobs{/sha}",
+  "git_tags_url": "https://api.github.com/repos/keenlabs/pushpop/git/tags{/sha}",
+  "git_refs_url": "https://api.github.com/repos/keenlabs/pushpop/git/refs{/sha}",
+  "trees_url": "https://api.github.com/repos/keenlabs/pushpop/git/trees{/sha}",
+  "statuses_url": "https://api.github.com/repos/keenlabs/pushpop/statuses/{sha}",
+  "languages_url": "https://api.github.com/repos/keenlabs/pushpop/languages",
+  "stargazers_url": "https://api.github.com/repos/keenlabs/pushpop/stargazers",
+  "contributors_url": "https://api.github.com/repos/keenlabs/pushpop/contributors",
+  "subscribers_url": "https://api.github.com/repos/keenlabs/pushpop/subscribers",
+  "subscription_url": "https://api.github.com/repos/keenlabs/pushpop/subscription",
+  "commits_url": "https://api.github.com/repos/keenlabs/pushpop/commits{/sha}",
+  "git_commits_url": "https://api.github.com/repos/keenlabs/pushpop/git/commits{/sha}",
+  "comments_url": "https://api.github.com/repos/keenlabs/pushpop/comments{/number}",
+  "issue_comment_url": "https://api.github.com/repos/keenlabs/pushpop/issues/comments/{number}",
+  "contents_url": "https://api.github.com/repos/keenlabs/pushpop/contents/{+path}",
+  "compare_url": "https://api.github.com/repos/keenlabs/pushpop/compare/{base}...{head}",
+  "merges_url": "https://api.github.com/repos/keenlabs/pushpop/merges",
+  "archive_url": "https://api.github.com/repos/keenlabs/pushpop/{archive_format}{/ref}",
+  "downloads_url": "https://api.github.com/repos/keenlabs/pushpop/downloads",
+  "issues_url": "https://api.github.com/repos/keenlabs/pushpop/issues{/number}",
+  "pulls_url": "https://api.github.com/repos/keenlabs/pushpop/pulls{/number}",
+  "milestones_url": "https://api.github.com/repos/keenlabs/pushpop/milestones{/number}",
+  "notifications_url": "https://api.github.com/repos/keenlabs/pushpop/notifications{?since,all,participating}",
+  "labels_url": "https://api.github.com/repos/keenlabs/pushpop/labels{/name}",
+  "releases_url": "https://api.github.com/repos/keenlabs/pushpop/releases{/id}",
+  "created_at": "2014-03-30T19:57:28Z",
+  "updated_at": "2014-06-09T06:15:31Z",
+  "pushed_at": "2014-05-22T00:54:09Z",
+  "git_url": "git://github.com/keenlabs/pushpop.git",
+  "ssh_url": "git@github.com:keenlabs/pushpop.git",
+  "clone_url": "https://github.com/keenlabs/pushpop.git",
+  "svn_url": "https://github.com/keenlabs/pushpop",
+  "homepage": "",
+  "size": 896,
+  "stargazers_count": 17,
+  "watchers_count": 17,
+  "language": "Ruby",
+  "has_issues": true,
+  "has_downloads": true,
+  "has_wiki": true,
+  "forks_count": 4,
+  "mirror_url": null,
+  "open_issues_count": 1,
+  "forks": 4,
+  "open_issues": 1,
+  "watchers": 17,
+  "default_branch": "master",
+  "organization": {
+    "login": "keenlabs",
+    "id": 1315418,
+    "avatar_url": "https://avatars.githubusercontent.com/u/1315418?",
+    "gravatar_id": "b948c4bc2de9618c488431612d2ff99d",
+    "url": "https://api.github.com/users/keenlabs",
+    "html_url": "https://github.com/keenlabs",
+    "followers_url": "https://api.github.com/users/keenlabs/followers",
+    "following_url": "https://api.github.com/users/keenlabs/following{/other_user}",
+    "gists_url": "https://api.github.com/users/keenlabs/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/keenlabs/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/keenlabs/subscriptions",
+    "organizations_url": "https://api.github.com/users/keenlabs/orgs",
+    "repos_url": "https://api.github.com/users/keenlabs/repos",
+    "events_url": "https://api.github.com/users/keenlabs/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/keenlabs/received_events",
+    "type": "Organization",
+    "site_admin": false
+  },
+  "network_count": 4,
+  "subscribers_count": 15
+}
+```
+Any of these properties can be accessed by calling the property name on the repository object:
+
+``` ruby
+repository.has_downloads  #=> true
+repository.owner.url      #=> "https://api.github.com/users/keenlabs"
+```
+
+See the [Github API Documentation](https://developer.github.com/v3) for more information.
+
+### Credits
+
+`pushpop-github` uses the excellent [github_api](https://github.com/peter-murach/github) gem to
+communicate with the Github API. It has, like, everything.
+
+### Contributing
+
+Please do! Run the specs with rake:
+
+``` shell
+$ bundle exec rake spec
+```

data/Rakefile

@@ -0,0 +1,16 @@
+$stdout.sync = true
+
+$: << File.join(File.dirname(__FILE__), './lib')
+
+begin
+  require 'rspec/core/rake_task'
+  desc 'Run Rspec unit tests'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+  task default: :spec
+rescue LoadError
+end
+
+

data/lib/pushpop-github.rb

@@ -0,0 +1,43 @@
+require 'pushpop'
+require 'github_api'
+
+module Pushpop
+
+  class Github < Step
+
+    PLUGIN_NAME = 'github'
+
+    Pushpop::Job.register_plugin(PLUGIN_NAME, self)
+
+    attr_accessor :_user
+    attr_accessor :_repository
+
+    def run(last_response=nil, step_responses=nil)
+      self.configure(last_response, step_responses)
+
+      if self._user && self._repository
+        get_repository_from_api
+      else
+        raise 'Please set user and repository fields'
+      end
+    end
+
+    def user(user)
+      self._user = user
+    end
+
+    def repository(repository)
+      self._repository = repository
+    end
+
+    def get_repository_from_api
+      ::Github::Repos.new(:user => self._user, :repo => self._repository).get
+    end
+
+    def configure(last_response=nil, step_responses=nil)
+      self.instance_exec(last_response, step_responses, &block)
+    end
+
+  end
+
+end

data/lib/pushpop-github/version.rb

@@ -0,0 +1,5 @@
+module Pushpop
+  class Github
+    VERSION = '0.1.0'
+  end
+end

data/pushpop-github.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pushpop-github/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = "pushpop-github"
+  s.version     = Pushpop::Github::VERSION
+  s.authors     = ["Josh Dzielak"]
+  s.email       = "josh@keen.io"
+  s.homepage    = "https://github.com/pushpop-project/pushpop-github"
+  s.summary     = "Github API plugin for pushpop"
+  s.description = "Github API plugin for pushpop"
+
+  s.add_dependency "pushpop"
+  s.add_dependency "github_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/spec/pushpop-github_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Pushpop::Github do
+  it 'should return repository information' do
+    step = Pushpop::Github.new do
+      user 'keenlabs'
+      repository 'pushpop'
+    end
+    repo = step.run
+    repo.language.should == "Ruby"
+  end
+
+  it 'should register as a plugin' do
+    github_job = job do
+      github do
+        user 'keenlabs'
+        repository 'pushpop'
+      end
+    end
+    repo, _ = github_job.run
+    repo.language.should == "Ruby"
+  end
+
+  it 'should raise an error if repository is not configured' do
+    expect {
+      step = Pushpop::Github.new do
+        user 'keenlabs'
+      end
+      step.run
+    }.to raise_error /Please set/
+  end
+
+  it 'should raise an error if user is not configured' do
+    expect {
+      step = Pushpop::Github.new do
+        repository 'pushpop'
+      end
+      step.run
+    }.to raise_error /Please set/
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$: << File.join(File.dirname(__FILE__), '../lib')
+
+require 'pushpop'
+require 'pushpop-github'
+
+RSpec.configure do |config|
+  config.before :each do
+    Pushpop.jobs.clear
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: pushpop-github
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Dzielak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pushpop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Github API plugin for pushpop
+email: josh@keen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pushpop-github.rb
+- lib/pushpop-github/version.rb
+- pushpop-github.gemspec
+- spec/pushpop-github_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pushpop-project/pushpop-github
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Github API plugin for pushpop
+test_files:
+- spec/pushpop-github_spec.rb
+- spec/spec_helper.rb