badgerkit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b3f0567b08710a9bc53f325d93b976b18176858
-  data.tar.gz: 38fc7e67247b3e22b9aa3cafc7018120218a50ee
+  metadata.gz: 822e9d773d47df68eea29c955cd919744edc8bea
+  data.tar.gz: 1c4a16e972413f82d65cbde54a81cf6665e474ad
 SHA512:
-  metadata.gz: 0c45b81716f4a64ae7a8e350de88e16175fa46a1d910649360f3b1eee7a8d4346062ae112f581be90bed3f6e1c70b5a91dd71abf7c827beeee94bb6964dfd6e3
-  data.tar.gz: 31253c58700d88e9821b26c6bbfa705daca7bd4b16893ba80420b98554a0162033b6292d2e886671741b96e08ab7c4ff2df0d7c7dd681c8c916fff636e77be47
+  metadata.gz: 9abbdc52f23c645dbfe6d0b37f163e006d755aecef2fab2051908e762b3b61de8ae307cbfdf6215577378b1d18a3bb9763d459e27e439f089c7a2e1da8358dc9
+  data.tar.gz: 23fce28db088b59f033177b514a471b7e13168b331acc792edd0a733477e366aa1e364d4fb46af7df90728a7f31034cf090bf15ca29719fbb0aab63a14ec1541

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,6 +1,18 @@
 # Badgerkit
 
-TODO: Write a gem description
+[![Gem Version](http://img.shields.io/gem/v/badgerkit.svg)][gem]
+[![Build Status](http://img.shields.io/travis/saladdays-nl/badgerkit.rb.svg)][travis]
+[![Coverage Status](http://img.shields.io/coveralls/saladdays-nl/badgerkit.rb.svg)][coveralls]
+[![Code Climate](http://img.shields.io/codeclimate/github/saladdays-nl/badgerkit.rb.svg)][codeclimate]
+[![Dependency Status](http://img.shields.io/gemnasium/saladdays-nl/badgerkit.rb.svg)][gemnasium]
+
+[gem]: https://rubygems.org/gems/badgerkit
+[travis]: http://travis-ci.org/saladdays-nl/badgerkit.rb
+[coveralls]: https://coveralls.io/r/saladdays-nl/badgerkit.rb
+[codeclimate]: https://codeclimate.com/github/saladdays-nl/badgerkit.rb
+[gemnasium]: https://gemnasium.com/saladdays-nl/badgerkit.rb
+
+Simple api wrapper for submitting data to http://badgerhq.com
 
 ## Installation
 
@@ -16,18 +28,45 @@ $ bundle
 
 ## Usage
 
+Without environment variables:
+
 ```ruby
-Badgerkit::Client.new(
-  :source => 'github'
-  :repo   => 'saladdays-nl/badgerkit.rb'
-  :name   => 'Ruby documentation'
-).post(
+client = Badgerkit.new(
+  :access_token => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
+  :source       => 'github',
+  :repo         => 'saladdays-nl/badgerkit.rb'
+)
+
+client.post('Documentation',
   :value       => 80,
   :commit_sha1 => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
   :branch      => 'master'
 )
 ```
 
+With the following environment variables:
+
+```ruby
+ENV['BADGER_ACCESS_TOKEN'] = '0dbce1478e94053d4282ccd4ace154c82a3475d5'
+ENV['BADGER_SOURCE']       = 'github'
+ENV['BADGER_REPO']         = 'saladdays/badgerkit.rb'
+
+Badgerkit.post('Documentation',
+  :value       => 80,
+  :commit_sha1 => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
+  :branch      => 'master'
+)
+```
+
+## Supported Ruby Versions
+
+This library is tested against Travis and aims to support the following Ruby
+implementations:
+
+* Ruby 1.9.3
+* Ruby 2.0.0
+* Ruby 2.1.1
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/badgekit/fork )

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/badgerkit.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rspec', '>= 2.3'
 
   spec.add_dependency "httparty"
   spec.add_dependency "hashie"

data/lib/badgerkit.rb

@@ -9,13 +9,20 @@ module Badgerkit
 
     # Alias for Badgerkit::Client.new
     #
-    # @return [Badgerkit::Client.]
+    # @return [Badgerkit::Client]
     #
     def new(options={})
       @options = options
       Badgerkit::Client.new(options)
     end
 
+    ##
+    # Delegates to {Badgerkit::Client#post}
+    #
+    def post(*args)
+      new.post(*args)
+    end
+
   end # class << self
 
 end # Badgerkit

data/lib/badgerkit/client.rb

@@ -3,8 +3,10 @@ module Badgerkit
   # Responsible for constructing a client which is able to post values.
   #
   class Client
+    require 'httparty'
+    require 'hashie'
 
-    attr_reader :path, :source, :repo, :name
+    attr_reader :path, :access_token, :source, :repo
 
     BASE_URI = 'http://badgerhq.com/'
 
@@ -12,24 +14,34 @@ module Badgerkit
     # Construct a new Badgekit::Client
     #
     # @param options [Hash]
+    # @option token [String] :token
     # @option options [String] :source
-    # @option options [String] :repo
+    # @option options [String] :app
     # @option options [String] :name
+
     # @return [Badgerkit::Client]
     # @example
     #   Badgerkit::Client.new(
-    #     :source => 'github'
-    #     :repo   => 'saladdays-nl/badgekit'
-    #     :name   => 'Ruby documentation'
+    #     :access_token => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
+    #     :source       => 'github',
+    #     :repo         => 'saladdays-nl/badgerkit'
     #   )
     #
     #
     def initialize(options={})
-      @source = options[:source]
-      @repo   = options[:repo]
-      @name   = options[:name]
+      @access_token = ENV['BADGER_ACCESS_TOKEN'] || options[:access_token]
+      @source       = ENV['BADGER_SOURCE']       || options[:source]
+      @repo         = ENV['BADGER_REPO']         || options[:repo]
+    end
 
-      @path = URI.escape("#{source}/#{repo}/#{name}")
+    ##
+    # Returns post path for badge.
+    #
+    # @param badge [String] the badge name
+    # @return [String] escaped path
+    #
+    def path_for(badge)
+      URI.escape("#{source}/#{repo}/#{badge}")
     end
 
     ##
@@ -41,15 +53,15 @@ module Badgerkit
     # @option attributes [String] :branch
     #
     # @example
-    #   client.post(
+    #   client.post('Documentation',
     #     :value       => 80,
     #     :commit_sha1 => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
     #     :branch      => 'master'
     #   )
     #
-    def post(attributes={})
-      attributes = { :value => attributes }
-      response   = HTTParty.post("#{BASE_URI}#{path}", :body => attributes).parsed_response
+    def post(badge, attributes={})
+      attributes = { :value => attributes, :access_token => access_token }
+      response   = HTTParty.post("#{BASE_URI}#{path_for(badge)}", :body => attributes).parsed_response
       response   = Hashie::Mash.new(response)
     end
 

data/lib/badgerkit/version.rb

@@ -1,4 +1,4 @@
 module Badgerkit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end # Badgerkit
 

data/spec/badgerkit/client_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Badgerkit::Client do
+
+  describe '#initialize' do
+
+    it 'should be able to set options' do
+      client = Badgerkit::Client.new(
+        :access_token => 'some_token',
+        :source       => 'github',
+        :repo         => 'saladdays/badgerkit.rb',
+      )
+      client.access_token.should == 'some_token'
+      client.source.should == 'github'
+      client.repo.should == 'saladdays/badgerkit.rb'
+    end
+
+  end
+
+  describe '#path_for' do
+
+    it 'should return escaped path to submit to' do
+      client = Badgerkit::Client.new(
+        :access_token => 'some_token',
+        :source       => 'github',
+        :repo         => 'saladdays/badgerkit.rb',
+      )
+      client.path_for('(rb) roverage').should == "github/saladdays/badgerkit.rb/(rb)%20roverage"
+    end
+
+  end
+
+  describe '#post' do
+
+    it 'should post with correct params' do
+      client = Badgerkit::Client.new(
+        :access_token => 'some_token',
+        :source       => 'github',
+        :repo         => 'saladdays/badgerkit.rb',
+      )
+
+      HTTParty.stub(:post).and_return(HTTPartyProxy.new)
+      HTTParty.should_receive(:post).with("http://badgerhq.com/github/saladdays/badgerkit.rb/Documentation",
+        :body => {
+          :value => {
+            :value       => 90,
+            :branch      => "master",
+            :commit_sha1 => "0dbce1478e94053d4282ccd4ace154c82a3475d5"
+          },
+          :access_token => 'some_token'
+        }
+      )
+
+      client.post('Documentation',
+        :value       => 90,
+        :branch      => 'master',
+        :commit_sha1 => '0dbce1478e94053d4282ccd4ace154c82a3475d5'
+      )
+    end
+
+  end
+
+end

data/spec/badgerkit_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Badgerkit do
+
+  subject { Badgerkit.new }
+
+  describe '.new' do
+
+    it 'is a Badgerkit::Client' do
+      expect(subject).to be_a Badgerkit::Client
+    end
+
+  end
+
+  describe '.post' do
+
+    it 'should delegate to Badgerkit::Client#post' do
+      HTTParty.stub(:post).and_return({})
+
+      Badgerkit::Client.any_instance.should_receive(:post).with('Documenation', :value => 9)
+
+      Badgerkit.post('Documenation', :value => 9)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+## Test coverage
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'support/httparty_proxy'
+
+## Rspec
+
+require 'rspec'
+require 'rspec/autorun'
+
+## Load alfred
+
+require 'badgerkit'

data/spec/support/httparty_proxy.rb

@@ -0,0 +1,10 @@
+# @private
+class HTTPartyProxy
+
+  attr_reader :parsed_response
+
+  def initialize(attributes={})
+    @parsed_response = attributes
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: badgerkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Johan van Zonneveld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,6 +111,10 @@ files:
 - lib/badgerkit.rb
 - lib/badgerkit/client.rb
 - lib/badgerkit/version.rb
+- spec/badgerkit/client_spec.rb
+- spec/badgerkit_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_proxy.rb
 homepage: https://github.com/saladdays-nl/badgerkit.rb
 licenses:
 - MIT
@@ -106,4 +139,8 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Toolkit for badgerhq.com
-test_files: []
+test_files:
+- spec/badgerkit/client_spec.rb
+- spec/badgerkit_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_proxy.rb