github_releases 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6afb8ede22c5ea03705e89949447bc46430f1759
+  data.tar.gz: 254ec6f8cb916df9ea7388724bfc2b52d78f9149
+SHA512:
+  metadata.gz: 23d6fa5661505f7f287e2ff6fe1b36a7de79e78058771547bee41dbb8e99ea504ecf852343ea0f0b4beb9e03afbd1659e380c7c6818956933d7386f92809ef2a
+  data.tar.gz: 0876224a9ce456a52b90f0a68f456a3e78421037bbb0442ea46ceb3d72ad01487b5666bffa0c97039621af2b0ba412cf05e198258c295b0b7f83bbfa8753f928

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 bbauer
+
+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,106 @@
+# Github Releases
+
+Github Releases creates an endpoint that exposes an app's releases for use in
+displaying a current version.
+
+## Current Version
+
+0.0.1
+
+## Requirements
+
+An app that utilizes Github's release feature
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem 'github_releases'
+   ```
+
+2. And then execute:
+
+   ```console
+   bundle
+   ```
+
+
+3. Configure your app in a config/initializers/github_releases.rb initializer
+
+   ```ruby
+   GithubReleases.setup do |config|
+      # configure your app's Github username
+      config.username = 'g5search'
+      # configure your app's Github repo name
+      config.repo = 'g5-cxm'
+   end
+
+   ```
+
+4. Install
+
+   ```ruby
+   rails g github_releases:install
+   ```
+
+   This mounts the engine at `/releases`.
+
+## Usage
+
+The engine exposes an endpoint at '/releases' that will list all of the app's
+releases in json. '/releases/latest' will expose the latest release to use in
+displaying your apps current version. You may also access any single release
+by id '/releases/:id'.
+
+## Authors
+
+* Brian Bauer / [@bbauer](https://github.com/bbauer)
+
+## Contributing
+
+1. [Fork it](https://github.com/g5search/github_releases/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your code and **specs**
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+If you find bugs, have feature requests or questions, please
+[file an issue](https://github.com/g5search/github_releases/issues).
+
+## Specs
+
+### Running the specs
+
+Run specs via `rspec` with:
+
+```bash
+$ rspec spec
+```
+
+## License
+
+Copyright (c) 2015 G5
+
+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/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GithubReleases'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/github_releases/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/github_releases/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/github_releases/application_controller.rb

@@ -0,0 +1,4 @@
+module GithubReleases
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/github_releases/releases_controller.rb

@@ -0,0 +1,9 @@
+class GithubReleases::ReleasesController < GithubReleases::ApplicationController
+  def index
+    render json: GithubReleases.releases, status: 200
+  end
+
+  def show
+    render json: GithubReleases.release(params[:id]), status: 200
+  end
+end

data/app/helpers/github_releases/application_helper.rb

@@ -0,0 +1,4 @@
+module GithubReleases
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/github_releases/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>GithubReleases</title>
+  <%= stylesheet_link_tag    "github_releases/application", media: "all" %>
+  <%= javascript_include_tag "github_releases/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+GithubReleases::Engine.routes.draw do
+  get '/:id', to: 'releases#show'
+  root 'releases#index'
+end

data/lib/generators/github_releases/install/install_generator.rb

@@ -0,0 +1,7 @@
+require 'rails/generators'
+
+class GithubReleases::InstallGenerator < Rails::Generators::Base
+  def mount_engine
+    route "mount G5Header::Engine => '/releases'"
+  end
+end

data/lib/generators/github_releases/install/templates/initializer.rb

@@ -0,0 +1,4 @@
+GithubReleases.setup do |config|
+  config.username = nil
+  config.repo = nil
+end

data/lib/github_releases/client.rb

@@ -0,0 +1,31 @@
+module GithubReleases::Client
+  def fetch(key, resource)
+    return cache.read(key) if cache.exist?(key)
+    cache.write(key, get(resource))
+    cache.read(key)
+  end
+
+  private
+
+  def get(resource)
+    JSON.parse(HTTParty.get(resource, headers: headers).body)
+  end
+
+  def headers
+    {
+      'Content-Type'  => 'application/json',
+      'Accept'        => 'application/vnd.github.v3+json',
+      'User-Agent'    => GithubReleases.username,
+      'Authorization' => "token #{ENV['GITHUB_API_TOKEN']}"
+    }
+  end
+
+  def endpoint
+    "#{GithubReleases.github_api}/repos/#{GithubReleases.username}/" \
+    "#{GithubReleases.repo}/releases"
+  end
+
+  def cache
+    Rails.cache
+  end
+end

data/lib/github_releases/engine.rb

@@ -0,0 +1,20 @@
+module GithubReleases
+  class Engine < ::Rails::Engine
+    isolate_namespace GithubReleases
+
+    config.autoload_paths << GithubReleases::Engine.root.join('lib')
+    config.generators { |g| g.test_framework :rspec }
+  end
+
+  class << self
+    mattr_accessor :repo, :username, :github_api
+
+    self.repo       = nil
+    self.username   = nil
+    self.github_api = 'https://api.github.com'
+  end
+
+  def self.setup(&block)
+    yield self
+  end
+end

data/lib/github_releases/version.rb

@@ -0,0 +1,3 @@
+module GithubReleases
+  VERSION = "0.0.1"
+end

data/lib/github_releases.rb

@@ -0,0 +1,52 @@
+require 'github_releases/engine'
+
+module GithubReleases
+  RELEASES_KEY = 'releases'
+  RELEASE_KEY  = 'release'
+  LATEST_ID    = 'latest'
+
+  class << self
+    def refresh_cache
+      cache.write(RELEASES_KEY, get(endpoint))
+      cache.write("#{RELEASE_KEY}-#{LATEST_ID}", get("#{endpoint}/#{LATEST_ID}"))
+    end
+
+    def releases
+      fetch(RELEASES_KEY, endpoint)
+    end
+
+    def release(id)
+      fetch("#{RELEASE_KEY}-#{id}", "#{endpoint}/#{id}")
+    end
+
+    private
+
+    def fetch(key, resource)
+      return cache.read(key) if cache.exist?(key)
+      cache.write(key, get(resource))
+      cache.read(key)
+    end
+
+    def get(resource)
+      JSON.parse(HTTParty.get(resource, headers: headers).body)
+    end
+
+    def headers
+      {
+        'Content-Type'  => 'application/json',
+        'Accept'        => 'application/vnd.github.v3+json',
+        'User-Agent'    => GithubReleases.username,
+        'Authorization' => "token #{ENV['GITHUB_API_TOKEN']}"
+      }
+    end
+
+    def endpoint
+      "#{GithubReleases.github_api}/repos/#{GithubReleases.username}/" \
+        "#{GithubReleases.repo}/releases"
+    end
+
+    def cache
+      Rails.cache
+    end
+  end
+end

data/lib/tasks/github_releases_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :github_releases do
+#   # Task goes here
+# end

data/lib/tasks/refresh_cache.rake

@@ -0,0 +1,6 @@
+namespace :github_releases do
+  desc 'Refreshes the cached API calls'
+  task refresh_cache: :environment do
+    GithubReleases.refresh_cache
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: github_releases
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bbauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: sqlite3
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Exposes an apps Github releases
+email:
+- brian.bauer@g5platform.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/github_releases/application.js
+- app/assets/stylesheets/github_releases/application.css
+- app/controllers/github_releases/application_controller.rb
+- app/controllers/github_releases/releases_controller.rb
+- app/helpers/github_releases/application_helper.rb
+- app/views/layouts/github_releases/application.html.erb
+- config/routes.rb
+- lib/generators/github_releases/install/install_generator.rb
+- lib/generators/github_releases/install/templates/initializer.rb
+- lib/github_releases.rb
+- lib/github_releases/client.rb
+- lib/github_releases/engine.rb
+- lib/github_releases/version.rb
+- lib/tasks/github_releases_tasks.rake
+- lib/tasks/refresh_cache.rake
+homepage: ''
+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.5
+signing_key: 
+specification_version: 4
+summary: Exposes an apps Github releases
+test_files: []