dashing-semaphore 1.0.0

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/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+First stable version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pierre-Louis Gottfrois
+
+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,73 @@
+# Dashing::Semaphore
+
+[Dashing-Rails](https://github.com/gottfrois/dashing-rails) widget that display build status of project on Semaphore CI.
+
+<img src="https://dl.dropbox.com/u/5802579/semaphore-dashing.png" width="600">
+
+## Installation
+
+Add this line to your [Dashing-Rails](https://github.com/gottfrois/dashing-rails) application's Gemfile:
+
+    gem 'dashing-semaphore'
+
+And then execute:
+
+    $ bundle
+
+## Getting Started
+
+Follow the following steps in order to make it work on your dashing-rails project:
+
+1. Add the following line to your `app/assets/javascripts/dashing/widgets/index.js` file:
+
+        //= require semaphore
+
+2. Add the following line to your `app/assets/stylesheets/dashing/widgets/index.css` file:
+
+        *= require semaphore
+
+3. Add the following html to your dashboard:
+
+        <li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
+            <div data-id="project_id" data-view="Semaphore" data-unordered="true" data-title="ProjectTitle"></div>
+        </li>
+
+4. Run
+
+        rails g dashing:semaphore:install
+
+5. Edit `config/initializers/dashing-semaphore.rb.rb` with your semaphore crendentials and project name as follow:
+
+        Dashing::Semaphore.configure do |config|
+            config.auth_token = 'your_auth_token_from_semaphore'
+            config.projects   = [
+                { widget_id: 'project_name/branch_name' },
+                { 'dashing-rails' => 'dashing-rails/master' } # For example
+            ]
+        end
+
+*Note: the branch name is optional*
+
+*Note: the paths to index files may have changed depending on your Dashing-Rails configuration.*
+
+## Fields
+
+### Required
+
+* `data-id`: Like all widgets, you must include an identifier so that your jobs can update the value. It is the same that the key value of the hash in `config/initializers/dashing-semaphore.rb.rb`.
+
+## 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
+
+## Author
+
+Full credits for this widget should go to [Aleksandar Diklic](https://github.com/rastasheep).
+
+## License
+
+dashing-semaphore is released under the MIT License. Developed by [rastasheep](https://github.com/rastasheep). Adapted by [gottfrois](https://github.com/gottfrois).

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/app/jobs/dashing/semaphore/scheduler.rb

@@ -0,0 +1,114 @@
+require 'delegate'
+require 'net/http'
+require 'uri'
+
+module Dashing
+  module Semaphore
+    class Scheduler < ::SimpleDelegator
+
+      include ActionView::Helpers::DateHelper
+
+      attr_reader :config, :frequence
+
+      def initialize(frequence)
+        @config     = Dashing::Semaphore.config
+        @frequence  = frequence
+        super(config)
+      end
+
+      def call
+        schedule if valid?
+      end
+
+      private
+
+      def schedule
+        Dashing.scheduler.every frequence, first_in: 1.second.since do
+          projects.each do |project|
+            key   = project.keys.first.to_s
+            item  = update_builds(project.values.first.to_s)
+            Dashing.send_event(key, items: [item])
+          end
+        end
+      end
+
+      def valid?
+        true
+      end
+
+      def update_builds(project)
+        query   = project.split('/')
+        project = search_project(json_response, query.first)
+
+        raise "no project with name #{query.first}" unless project
+
+        branch = search_branch(project, query)
+
+        raise "no branch with name #{query[1]} for project #{query[0]}" unless branch
+
+        build_info(branch)
+      end
+
+      def build_info(branch)
+        info        = OpenStruct.new
+        info.label  = branch['branch_name']
+        info.value  = "Build #{branch['build_number']}, #{branch['result']}"
+        info.time   = calculate_time(branch['finished_at'])
+        info.state  = branch['result']
+
+        info
+      end
+
+      def calculate_time(time)
+        time ? time_ago_in_words(Time.parse(time)) : 'Not built yet'
+      end
+
+      def search_branch(project, query)
+        query.size > 1 ? search_by_branch_name(project, query) : search_within_last_build(project)
+      end
+
+      def search_by_branch_name(project, branch)
+        project['branches'].find { |b| b['branch_name'] == branch[1] } if project['branches']
+      end
+
+      def search_within_last_build(project)
+        project['branches'].last if project['branches']
+      end
+
+      def search_project(json, project)
+        json.find { |p| p['name'] == project }
+      end
+
+      def http
+        @http ||= ::Net::HTTP.new(uri.host, uri.port)
+        @http.use_ssl = true
+        @http
+      end
+
+      def request
+        @request ||= ::Net::HTTP::Get.new(uri.request_uri)
+      end
+
+      def response
+        @response ||= http.request(request)
+      end
+
+      def json_response
+        JSON.parse(response.body)
+      end
+
+      def uri
+        @uri ||= ::URI.parse("https://semaphoreapp.com/api/v1/projects?auth_token=#{auth_token}")
+      end
+
+      def projects
+        config.projects
+      end
+
+      def auth_token
+        config.auth_token
+      end
+
+    end
+  end
+end

data/app/views/dashing/semaphore/semaphore.html

@@ -0,0 +1,21 @@
+<h1 class="title" data-bind="title"></h1>
+
+<img src="/assets/semaphore-logo.png" data-addclass-ok="item.table.state">
+
+<ol>
+  <li data-foreach-item="items">
+  <span class="label" data-bind="item.table.label"></span>
+  <span class="value" data-bind="item.table.value"></span>
+  </li>
+</ol>
+
+<ul class="list-nostyle">
+  <li data-foreach-item="items">
+  <span class="label" data-bind="item.table.label"></span>
+  <span class="value" data-bind="item.table.value"></span>
+  <span class="label" data-bind="item.table.time"></span>
+  </li>
+</ul>
+
+<p class="more-info" data-bind="moreinfo"></p>
+<p class="updated-at" data-bind="updatedAtMessage"></p>

data/dashing-semaphore.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dashing/semaphore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dashing-semaphore"
+  spec.version       = Dashing::Semaphore::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierrelouis.gottfrois@gmail.com"]
+  spec.description   = %q{Dashing widget that display build status of project on Semaphore CI}
+  spec.summary       = %q{Dashing widget that display build status of project on Semaphore CI}
+  spec.homepage      = "https://github.com/gottfrois/dashing-semaphore"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/dashing/semaphore.rb

@@ -0,0 +1,21 @@
+require 'dashing/semaphore/version'
+
+module Dashing
+  module Semaphore
+    class << self
+
+      attr_accessor :configuration
+
+      def config
+        self.configuration ||= Configuration.new
+      end
+
+      def configure
+        yield config if block_given?
+      end
+    end
+  end
+end
+
+require 'dashing/semaphore/configuration'
+require 'dashing/semaphore/engine'

data/lib/dashing/semaphore/configuration.rb

@@ -0,0 +1,14 @@
+module Dashing
+  module Semaphore
+    class Configuration
+
+      attr_accessor :auth_token, :projects
+
+      def initialize
+        @auth_token = ''
+        @projects   = []
+      end
+
+    end
+  end
+end

data/lib/dashing/semaphore/engine.rb

@@ -0,0 +1,16 @@
+module Dashing
+  module Semaphore
+    class Engine < ::Rails::Engine
+
+      config.assets.paths.unshift       Dashing::Semaphore::Engine.root.join('vendor', 'assets', 'javascripts', 'dashing')
+      config.assets.paths.unshift       Dashing::Semaphore::Engine.root.join('vendor', 'assets', 'stylesheets', 'dashing')
+      config.assets.paths.unshift       Dashing::Semaphore::Engine.root.join('vendor', 'assets', 'images')
+      config.paths['app/views'].unshift Dashing::Semaphore::Engine.root.join('app', 'views', 'dashing', 'semaphore')
+
+      initializer 'require dashing semaphore jobs' do
+        Dir[Dashing::Semaphore::Engine.root.join('app', 'jobs', '**', '*.rb')].each { |file| require file }
+      end
+
+    end
+  end
+end

data/lib/dashing/semaphore/version.rb

@@ -0,0 +1,5 @@
+module Dashing
+  module Semaphore
+    VERSION = '1.0.0'
+  end
+end

data/lib/generators/dashing/semaphore/install_generator.rb

@@ -0,0 +1,21 @@
+module Dashing
+  module Semaphore
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+
+        source_root File.expand_path('../../../templates', __FILE__)
+
+        desc 'Creates semaphore.rb initializer for your application.'
+
+        def copy_initializer
+          template 'initializer.rb', 'config/initializers/dashing-semaphore.rb'
+        end
+
+        def copy_job
+          template 'jobs/semaphore.rb', 'app/jobs/semaphore.rb'
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,11 @@
+# Use this hook to configure Dashing-Semaphore bahaviors.
+Dashing::Semaphore.configure do |config|
+  # You semaphore auth token.
+  # config.auth_token = 'your_auth_token_from_semaphore'
+
+  # A list of hash where the key is the widget_id and the value is your
+  # semaphore project name and an optional branch name.
+  # config.projects = [
+  #   { widget_id: 'project_name/branch_name'}
+  # ]
+end

data/lib/generators/templates/jobs/semaphore.rb

@@ -0,0 +1,2 @@
+# You can set the frequency here.
+Dashing::Semaphore::Scheduler.new('10s').call

data/vendor/assets/javascripts/dashing/semaphore/index.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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/vendor/assets/javascripts/dashing/semaphore/semaphore.coffee

@@ -0,0 +1,15 @@
+class Dashing.Semaphore extends Dashing.Widget
+  ready: ->
+    @get('unordered')
+    if @get('unordered')
+      $(@node).find('ol').remove()
+    else
+      $(@node).find('ul').remove()
+      @_checkStatus(@items[0].table.state)
+
+  onData: (data) ->
+    @_checkStatus(data.items[0].table.state)
+
+  _checkStatus: (status) ->
+    $(@node).removeClass('failed pending  passed')
+    $(@node).addClass(status)

data/vendor/assets/stylesheets/dashing/semaphore/index.css

@@ -0,0 +1,12 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ */

data/vendor/assets/stylesheets/dashing/semaphore/semaphore.scss

@@ -0,0 +1,83 @@
+$value-color:              #FFF;
+$background-color:         #8fb347;
+$background-error-color:   #ad3b0e;
+$background-passed-color:  #8fb347;
+$background-pending-color:  #47bbb3;
+
+$title-color:       rgba(255, 255, 255, 0.7);
+$label-color:       rgba(255, 255, 255, 0.7);
+$moreinfo-color:    rgba(255, 255, 255, 0.7);
+
+.widget-semaphore{
+
+  background-color: $background-color;
+  vertical-align: top;
+
+  img {
+    width: 100% !important;
+    position: absolute;
+    left: 0;
+    top: 30px;
+    opacity: 0.05;
+  }
+
+  .title {
+    color: $title-color;
+  }
+
+  ol, ul {
+    margin: 0 15px;
+    text-align: left;
+    color: $label-color;
+  }
+
+  ol {
+    list-style-position: inside;
+  }
+
+  li {
+    margin-bottom: 5px;
+  }
+
+  .list-nostyle {
+    list-style: none;
+  }
+
+  .label {
+    text-align: center;
+    display: block;
+    color: $label-color;
+    font-size: 24px;
+    word-wrap: break-word;
+  }
+
+  .value {
+    text-align: center;
+    display: block;
+    font-weight: 600;
+    color: $value-color;
+    font-size: 24px;
+    word-wrap: break-word;
+  }
+
+  .updated-at {
+    color: rgba(0, 0, 0, 0.3);
+  }
+
+  .more-info {
+    color: $moreinfo-color;
+  }
+
+  &.failed {
+    background-color: $background-error-color;
+  }
+
+  &.pending {
+    background-color: $background-pending-color;
+  }
+
+  &.passed {
+    background-color: $background-passed-color;
+  }
+
+}

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: dashing-semaphore
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pierre-Louis Gottfrois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dashing widget that display build status of project on Semaphore CI
+email:
+- pierrelouis.gottfrois@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/jobs/dashing/semaphore/scheduler.rb
+- app/views/dashing/semaphore/semaphore.html
+- dashing-semaphore.gemspec
+- lib/dashing/semaphore.rb
+- lib/dashing/semaphore/configuration.rb
+- lib/dashing/semaphore/engine.rb
+- lib/dashing/semaphore/version.rb
+- lib/generators/dashing/semaphore/install_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/jobs/semaphore.rb
+- vendor/assets/images/semaphore-logo.png
+- vendor/assets/javascripts/dashing/semaphore/index.js
+- vendor/assets/javascripts/dashing/semaphore/semaphore.coffee
+- vendor/assets/stylesheets/dashing/semaphore/index.css
+- vendor/assets/stylesheets/dashing/semaphore/semaphore.scss
+homepage: https://github.com/gottfrois/dashing-semaphore
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 247761134562443647
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 247761134562443647
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Dashing widget that display build status of project on Semaphore CI
+test_files: []