github_releases 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: becf719af0caba624f4045a612becc9ed5295c35
-  data.tar.gz: 917446e7bcee76ebfc874a427a8784d1015cfb40
+  metadata.gz: 8df93686d5c35a861acdb0fd62da461a9f8690d8
+  data.tar.gz: 9c5e71e95a7cf628918e55c591b73e68ffbb2113
 SHA512:
-  metadata.gz: 2d5ac9ddab28e18887208df0a14256b06ee032507cac358dbef842aa777a9b7dceec534c8492ae1c23db1353f5845e2cdd39a4bfa4d1a73c8b15b67899eaff32
-  data.tar.gz: 32e0c001ef4339472e05792e314abc22f569b4bb43d8d7b5614c79d996659b838d9b3c813cc155516e801b755327fd24df2ad809e80fd3e82b4df12b1d38eca0
+  metadata.gz: c2792271d180d4b92309766c26379623f8f75952ca6d3dbcc5a123924c16fbb23f67d08f65552d78535e2a1c0249e4c10a367da02630edb33cd703421850dc7f
+  data.tar.gz: 16b740d878071b602019adb1aeac68b1ab9a4387ae0f75c5a6005bb10e5fb741b42cfba728074b52caaee7da170914e13168f6a78b905ded97de3b812829140e

data/README.md

@@ -36,14 +36,24 @@ An app that utilizes Github's release feature
    end
 
    ```
+   
+4. Set your GitHub API token in a GITHUB_API_TOKEN environment variable.
 
-4. Install
+5. Install
 
    ```ruby
    rails g github_releases:install
    ```
 
    This mounts the engine at `/releases`.
+   
+   If you're using a pure Rails app, and want to use the current_version view helper, add     GithubReleases::ApplicationHelper to your ApplicationController.
+
+   ```ruby
+   class ApplicationController < ActionController::Base
+      helper GithubReleases::ApplicationHelper
+   end
+   ```
 
 ## Usage
 
@@ -52,6 +62,32 @@ 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'.
 
+For pure Rails apps, you may access the current_version of your app with a view helper...
+
+```Ruby
+<%= current_version %>
+```
+
+Or if you don't want to add the helper module to your controller, you can call the class directly...
+
+```Ruby
+<%= GithubReleases.release('latest')['tag_name'] %>
+```
+
+**IMPORTANT** All calls to the GitHub API are cached. It's up to you to refresh the cache when releases should be updated. There are two ways to do this. Via the rake task...
+
+```
+rake github_releases:refresh_cache
+```
+
+Or via a Ruby class method...
+
+```Ruby
+GithubReleases.refresh_cache
+```
+
+One strategy is to run the rake task in a post deploy hook.
+
 ## Authors
 
 * Brian Bauer / [@bbauer](https://github.com/bbauer)

data/app/controllers/github_releases/releases_controller.rb

@@ -1,9 +1,13 @@
 class GithubReleases::ReleasesController < GithubReleases::ApplicationController
   def index
-    render json: GithubReleases.releases, status: 200
+    render json: GithubReleases.all, status: 200
   end
 
   def show
-    render json: GithubReleases.release(params[:id]), status: 200
+    render json: GithubReleases.find(params[:id]), status: 200
+  end
+
+  def current_version
+    render json: { version: GithubReleases.current_version }, status: 200
   end
 end

data/app/helpers/github_releases/application_helper.rb

@@ -1,7 +1,4 @@
 module GithubReleases
   module ApplicationHelper
-    def current_version
-      GithubReleases.release('latest')['tag_name']
-    end
   end
 end

data/config/routes.rb

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

data/lib/github_releases/version.rb

@@ -1,3 +1,3 @@
 module GithubReleases
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/github_releases.rb

@@ -6,19 +6,23 @@ module GithubReleases
   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
+    def all
       fetch(RELEASES_KEY, endpoint)
     end
 
-    def release(id)
+    def find(id)
       fetch("#{RELEASE_KEY}-#{id}", "#{endpoint}/#{id}")
     end
 
+    def current_version
+      ENV['CURRENT_VERSION'] || find(LATEST_ID)['tag_name']
+    end
+
+    def refresh
+      cache.write(RELEASES_KEY, get(endpoint))
+      cache.write("#{RELEASE_KEY}-#{LATEST_ID}", get("#{endpoint}/#{LATEST_ID}"))
+    end
+
     private
 
     def fetch(key, resource)

data/lib/tasks/{refresh_cache.rake → refresh.rake}

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_releases
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - bbauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,7 +104,7 @@ files:
 - lib/github_releases/engine.rb
 - lib/github_releases/version.rb
 - lib/tasks/github_releases_tasks.rake
-- lib/tasks/refresh_cache.rake
+- lib/tasks/refresh.rake
 homepage: ''
 licenses:
 - MIT