coderbits 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f3f89f4d80c71f4f30ccec6aeb3e3e4537d99b7
-  data.tar.gz: 4f4ec14200e32a65f7a2006c49771fa0a9df8183
+  metadata.gz: c31dfc8d60d7f5ad255e2f6826b0d50c202b09ac
+  data.tar.gz: c8b8b1a85c77bb29b57d1de768616edc724ade41
 SHA512:
-  metadata.gz: d14bfbc1f15991c35d29f491e3ca034c491d001f0aab185a4734c5173869b5b3428d32a199364612236b112bc397cfd695719c0b69f64767988a2c1f485b1ca7
-  data.tar.gz: 494a6e187229d9de9f030c540a4b4157abf6a495b1a00e39550553711c115a31fc5b7bd36ab875e3cf729f6a422013e4bf613a061b73475153df0debb2c8a96f
+  metadata.gz: d957113f9ee4d8d9f6ffddfff4aafe0d77ba55ce05b6f739327b9f3d9ca3c1ae3cb2cf324a89f8f4697127e0d6eae116ddcf5ac6472220f47134623d8daa849e
+  data.tar.gz: eac8e94bbf1632fb8a7657ab9c0feb69562c2918e3dfa6ccaef69b5aa4a5d71c85570240f67b118b1875a353b2c3368a2f968628da5b6d943de045b907edfdac

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### [1.0.0]
+
+* Remove .glue method
+* Remove unused dependencies
+* Enhance specs
+
+### [0.1.0](https://github.com/artemeff/coderbits/commit/3dd43979b91e1d91aa1400a50b25acccdcfdf054)
+
+* Add html code generator
+* Refactoring
+
 ### 0.0.3
 
 * :save_to fix

data/README.md

@@ -16,34 +16,16 @@ Simple wrapper for the Coderbits API
 ```ruby
 require 'coderbits'
 
-# Create sprite image with css code for earned badges
-Coderbits.glue('artemeff').run!
-
-# With options
-Coderbits.glue('artemeff', glue_options).run!
-
 # Get user info
 Codebits.get 'artemeff'
-```
 
-### Options
+# Or you may initialize connection
+client = Coderbits.new
 
-__Glue options__:
-
-```ruby
-:badge_size     # badges size for download
-:save_to        # path for files
-:layout         # horizontal, vertical or packed
-:style          # css, scss or sass
-:library        # rmagick or chunkypng
-:selector       # selector
-:padding        # add padding to each sprite
-:margin         # add margin to each sprite
-:nocomments     # suppress generation of comments in output stylesheet
-:output_image   # output location for generated image
-:output_style   # output location for generated stylesheet
+# And get data by this way
+client.get 'artemeff'
 ```
 
 ### Copyright
 
-Copyright (c) 2012 Yuri Artemev. See LICENSE.txt for further details.
+Copyright (c) 2012 Yuri Artemev. See [LICENSE](https://github.com/artemeff/coderbits/blob/master/LICENSE) for further details.

data/coderbits.gemspec

@@ -1,13 +1,14 @@
 # coding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "coderbits/version"
 
 Gem::Specification.new do |s|
   s.name = "coderbits"
-  s.version = Colos::VERSION
+  s.version = Coderbits::VERSION
   s.authors = ["Yuri Artemev"]
   s.email = ["i@artemeff.com"]
-  s.homepage = "http://github.com/artemeff/coderbits"
+  s.homepage = "https://github.com/artemeff/coderbits"
   s.description = %q{Simple wrapper for the Coderbits API}
   s.summary = %q{Coderbits API wrapper}
   s.files = %w(CHANGELOG.md README.md LICENSE Rakefile coderbits.gemspec)
@@ -17,11 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.test_files = Dir.glob("spec/**/*")
 
-  s.add_development_dependency 'bundler', '~> 1.0'
   s.add_dependency 'faraday', '~> 0.8'
-  s.add_dependency 'faraday_middleware', '~> 0.8'
-  s.add_dependency 'multi_json', '~> 1.7'
-  s.add_dependency 'sprite-factory', '~> 1.5'
-  s.add_dependency 'chunky_png', '~> 1.2'
+  s.add_dependency 'multi_json', '~> 1.3'
   s.add_dependency 'hashie', '~> 2.0'
 end

data/lib/coderbits.rb

@@ -1,26 +1,23 @@
-require 'sprite_factory'
 require 'multi_json'
 require 'hashie'
 require 'faraday'
-require 'faraday_middleware'
 
-require 'coderbits/defaults'
 require 'coderbits/client'
-require 'coderbits/object'
-require 'coderbits/glue'
+require 'coderbits/version'
 
 module Coderbits
   class << self
-    # Alias for Coderbits::Client.new.get
-    def new username, options = {}
-      Coderbits::Client.new.get username, options
+    # alias for Coderbits::Client.new
+    def new options = {}
+      Coderbits::Client.new options
     end
-    
-    alias_method :get, :new
 
-    # Alias for Coderbits::Glue.new(...)
-    def glue username, options = {}
-      Coderbits::Glue.new username, options
+    # alias for Coderbits::Client.new.get
+    def get username, options = {}
+      Coderbits::Client.new.get username, options
     end
   end
+
+  # attach Hashie to data
+  class Object < Hashie::Mash; end
 end

data/lib/coderbits/client.rb

@@ -1,26 +1,30 @@
 module Coderbits
   class Client
-    # valid options
-    OPTIONS = [:account, :callback]
+    # default faraday options
+    BASE_URL = "https://coderbits.com/"
+    HEADERS  = { accept: 'application/json' }
+    SSL      = { verify: false }
 
-    # connection
+    # faraday instance only for reading
     attr_reader :connection
 
-    # Coderbits::Client.new
-    # establish faraday connection
+    # create instance of faraday
     def initialize options = {}
-      options[:url]     ||= Coderbits::Defaults::BASE_URL
-      options[:headers] ||= Coderbits::Defaults::HEADERS
-      options[:ssl]     ||= Coderbits::Defaults::SSL
+      options = safe(options, [:headers, :ssl])
 
-      @connection = Faraday.new(options)
+      params = {
+        url: BASE_URL,
+        headers: options[:headers] || HEADERS.merge({'User-Agent' => "Ruby Coderbits #{Coderbits::VERSION}"}),
+        ssl: options[:ssl] || SSL
+      }
+
+      @connection = Faraday.new params
     end
 
-    # Coderbits::Client.new.get username: 'artemeff'
     # gets user data
     def get username, options = {}
       begin
-        response = @connection.get "/#{username}.json", safe(options)
+        response = @connection.get "/#{username}.json", safe(options, [:account, :callback])
 
         status = response.status
         error  = false
@@ -48,10 +52,9 @@ module Coderbits
 
   private
 
-    # safety option
-    def safe options
-      options.select { |k, v| OPTIONS.include? k }
+    def safe options, allowed
+      options.select { |k, v| allowed.include? k }
     end
 
   end
-end
+end

data/lib/coderbits/version.rb

@@ -1,3 +1,3 @@
-class Colos
-  VERSION = "0.1.0"
-end
+module Coderbits
+  VERSION = "1.0.0"
+end

data/spec/coderbits/client_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Coderbits::Client do
 
   describe ".new" do
-    it "should have connection" do
+    it "setup faraday instance" do
       expect(Coderbits::Client.new.connection).to be_a Faraday::Connection
     end
   end
@@ -11,75 +11,84 @@ describe Coderbits::Client do
   describe ".get" do
 
     describe "without options" do
-      before do
-        @data = Coderbits::Client.new.get 'artemeff'
-      end
+      let(:data) { Coderbits::Client.new.get 'artemeff' }
 
-      it "should be a Coderbits::Object instance" do
-        expect(@data).to be_a Coderbits::Object
+      it "is a Coderbits::Object instance" do
+        expect(data).to be_a Coderbits::Object
       end
 
-      it "should return status eq 200" do
-        @data.status.should be 200
+      it "return status 200" do
+        data.status.should be 200
       end
 
-      it "shouldn't have error" do
-        @data.error.should be false
+      it "runs without errors" do
+        data.error.should be false
       end
 
-      it "should have username" do
-        @data.should include :username
+      it "have username" do
+        data.should include :username
       end
     end
 
     describe "with options" do
-      it "should be a String with callback option" do
-        data = Coderbits::Client.new.get 'artemeff', callback: 'testFunc'
-
-        data.should be_an_instance_of String
-      end
+      describe "callback" do
+        let(:data) { Coderbits::Client.new.get 'artemeff', callback: 'callbackFunction' }
 
-      it "should be a Coderbits::Object with account option" do
-        data = Coderbits::Client.new.get 'artemeff', account: 'github'
+        it "return string" do
+          expect(data).to be_a String
+        end
 
-        data.should be_an_instance_of Coderbits::Object
+        it "have callback function" do
+          data.should include("callbackFunction")
+        end
       end
+
+      #describe "account" do
+      #  let(:data) { Coderbits::Client.new.get 'artemeff', account: 'github' }
+      #
+      #  it do
+      #    pending "i don't know what is that, but i should wrote this"
+      #  end
+      #end
     end
 
-    describe "with nonexistent user" do
-      before do
-        @data = Coderbits::Client.new.get "prettyuserthatdoesntexist#{rand(10)}"
-      end
+    describe "with user that does not exist" do
+      let(:data) { Coderbits::Client.new.get "i_am_not_in_danger_skyler_i_am_the_danger" }
 
-      it "should have 200 status" do
-        @data.status.should be 200
+      it "return status 200" do
+        data.status.should be 200
       end
 
-      it "should have error" do
-        @data.error.should match "User not found"
+      it "have errors" do
+        data.error.should match "User not found"
       end
     end
   end
 
   describe "#safe" do
-    before do
-      @client = Coderbits::Client.new
-
-      @options = {
-        bad_option: false,
-        account: 'github',
-        callback: 'testFunc'
+    let(:client)  { Coderbits::Client.new }
+    let(:allowed) { [:foo, :bar] }
+    let(:options) do
+      {
+        foo: 1,
+        bar: 2,
+        baz: 3
       }
     end
 
-    it "should have bad option" do
-      @options.should include :bad_option
+    it "have bad option" do
+      options.should include :baz
+    end
+
+    it "delete bad option" do
+      client.send(:safe, options, allowed).should_not include :baz
     end
 
-    it "should delete bad options" do
-      safe = @client.send :safe, @options
+    it "have allowed options after safing" do
+      params = client.send(:safe, options, allowed)
 
-      safe.should_not include :bad_option
+      params.should include :foo
+      params.should include :bar
     end
   end
 

data/spec/coderbits_spec.rb

@@ -1,17 +1,15 @@
 require 'spec_helper'
 
 describe Coderbits do
-
-  describe ".new and .get" do
-    it "is a Coderbits::Client" do
-      expect(Coderbits.new('artemeff')).to be_a Hash
+  describe ".new" do
+    it "is a Coderbits::Client.new" do
+      expect(Coderbits.new).to be_a Coderbits::Client
     end
   end
 
-  describe ".glue" do
-    it "is a Coderbits::Glue" do
-      expect(Coderbits.glue('artemeff')).to be_a Coderbits::Glue
+  describe ".get" do
+    it "is a Coderbits::Client.new.get" do
+      expect(Coderbits.get('artemeff')).to be_a Hash
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,6 +1,2 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'rspec'
 require 'coderbits'
-require 'fileutils'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coderbits
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuri Artemev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -38,62 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: sprite-factory
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: chunky_png
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -121,16 +65,12 @@ files:
 - Rakefile
 - coderbits.gemspec
 - lib/coderbits/client.rb
-- lib/coderbits/defaults.rb
-- lib/coderbits/glue.rb
-- lib/coderbits/object.rb
 - lib/coderbits/version.rb
 - lib/coderbits.rb
 - spec/coderbits/client_spec.rb
-- spec/coderbits/glue_spec.rb
 - spec/coderbits_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/artemeff/coderbits
+homepage: https://github.com/artemeff/coderbits
 licenses:
 - MIT
 metadata: {}
@@ -156,7 +96,6 @@ specification_version: 4
 summary: Coderbits API wrapper
 test_files:
 - spec/coderbits/client_spec.rb
-- spec/coderbits/glue_spec.rb
 - spec/coderbits_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/coderbits/defaults.rb

@@ -1,7 +0,0 @@
-module Coderbits
-  module Defaults
-    BASE_URL = 'https://coderbits.com'        unless defined? Coderbits::Defaults::BASE_URL
-    HEADERS  = { accept: 'application/json' } unless defined? Coderbits::Defaults::HEADERS
-    SSL      = { verify: false }              unless defined? Coderbits::Defaults::SSL
-  end
-end

data/lib/coderbits/glue.rb

@@ -1,116 +0,0 @@
-module Coderbits
-  class Glue
-    # valid options
-    OPTIONS = [
-      :badge_size, :save_to, :layout, :style, :library, :selector,
-      :padding, :margin, :nocomments, :output_image, :output_style,
-      :width, :height
-    ]
-
-    def initialize username, options = {}
-      safe options
-      @username = username
-    end
-
-    # launching all rockets
-    def run!
-      imgs = download_images
-      css  = merge_images
-      html = generate_html imgs
-
-      {
-        images: imgs,
-        css: css,
-        html: html
-      }
-    end
-
-    def download_images
-      # get user data
-      data = Coderbits::Client.new.get @username
-
-      # collect images
-      images = data.badges.select { |b| b.earned }.map { |b| b.image_link.match(/(.*)\/(.*)/)[2] }.uniq
-
-      # create directories
-      Dir.mkdir @options[:save_to] unless Dir.exists? @options[:save_to]
-      Dir.mkdir "#{@options[:save_to]}/badges" unless Dir.exists? "#{@options[:save_to]}/badges"
-
-      # connection for download images
-      connection = Coderbits::Client.new(headers: { accept: 'image/png' }).connection
-
-      # download images
-      images.each do |img|
-        # specify badge size
-        img = change_size img unless @options[:badge_size] == 64
-
-        # download image
-        begin
-          response = connection.get "/images/badges/#{img}"
-
-          # save to disk
-          if response.headers["content-type"] == "image/png"
-            File.open("#{@options[:save_to]}/badges/#{img.downcase}", 'wb') { |f| f.write response.body }
-          end
-        rescue Exception => e
-          # TODO logging
-        end
-      end
-    end
-
-    # merge and generate css by SpriteFactory
-    def merge_images
-      SpriteFactory.run! "#{@options[:save_to]}/badges", @options
-    end
-
-    def generate_html images
-      html_tags = []
-
-      images.each do |name|
-        html_tags << "<img src='#{@options[:output_image]}' class='#{@options[:selector][1..-1]}#{name.downcase.gsub(/.png/,'')}'>"
-      end
-
-      html_tags.join "\n"
-    end
-
-    def safe options
-      # select only allowed options
-      options = options.select { |k, v| OPTIONS.include? k }
-
-      dflt = {
-        badge_size: 64,       # badges size for download
-        save_to: '.',        # path for files
-
-        layout: 'horizontal', # horizontal, vertical or packed
-        style: 'css',         # css, scss or sass
-        library: 'chunkypng', # rmagick or chunkypng
-        selector: '.badge-',  # selector
-        padding: 0,           # add padding to each sprite
-        margin: 0,            # add margin to each sprite
-        nocomments: true      # suppress generation of comments in output stylesheet
-      }
-
-      if options.has_key? :save_to
-        save_to = options[:save_to]
-      else
-        save_to = dflt[:save_to]
-      end
-      
-      dflt[:output_image] = "#{save_to}/badges.png" # output location for generated image
-      dflt[:output_style] = "#{save_to}/badges.css" # output location for generated stylesheet
-
-      @options = dflt.merge options
-    end
-
-  private
-
-    def change_size filename
-      # parse image name
-      params = filename.match /([A-z\-_]+)(\d+).png/
-      
-      # custom badge size
-      "#{params[1]}#{@options[:badge_size]}.png"
-    end
-
-  end
-end

data/lib/coderbits/object.rb

@@ -1,5 +0,0 @@
-module Coderbits
-  class Object < Hashie::Mash
-
-  end
-end

data/spec/coderbits/glue_spec.rb

@@ -1,50 +0,0 @@
-require 'spec_helper'
-
-describe Coderbits::Glue do
-
-  describe ".new" do
-    before do
-      @glue = Coderbits::Glue.new 'artemeff', save_to: './temp/'
-    end
-
-    it "should have username" do
-      @glue.instance_variable_get(:@username).should have(8).characters
-    end
-  end
-
-  describe ".run!" do
-    after do
-      FileUtils.rm_rf './temp/'
-    end
-
-    it "should work" do
-      Coderbits.glue('artemeff', save_to: './temp/').run!
-    end
-
-    it "should work with custom badge size" do
-      Coderbits.glue('artemeff', badge_size: 32, save_to: './temp/').run!
-    end
-  end
-
-  describe "#safe" do
-    before do
-      @glue = Coderbits::Glue.new 'artemeff'
-
-      @options = {
-        bad_option: false,
-        save_to: './'
-      }
-    end
-
-    it "should have bad option" do
-      @options.should include :bad_option
-    end
-
-    it "should delete bad options" do
-      safe = @glue.send :safe, @options
-
-      safe.should_not include :bad_option
-    end
-  end
-
-end