carmine 0.1.0

data/Gemfile

@@ -0,0 +1,11 @@
+source :gemcutter
+
+gem 'httparty'
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    git (1.2.5)
+    guard (1.0.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    multi_json (1.1.0)
+    multi_xml (0.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  httparty
+  jeweler
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec, :cli => '-f doc -r "spec_helper" -c' do
+  watch(%r{^lib/(.+)\.rb$})  { 'spec' }
+  watch(%r{^spec/(.+)\.rb$}) { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 by Genadi Samokovarov
+
+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,3 @@
+Dir['tasks/**/*.rake'].each do |taskfile|
+  load taskfile
+end

data/Readme.markdown

@@ -0,0 +1,35 @@
+Carmine is a [ruby](http://ruby-lang.org) client for [pygmentize.me](http://pygmentize.me) - your friendly syntax highlighting service.
+
+# Usage
+
+```ruby
+require 'carmine'
+
+Carmine.colorize 'puts "Hello World!"', :lexer => :ruby, :formatter => :terminal256
+```
+
+# Installation
+
+    gem install carmine
+
+# License
+
+Copyright (C) 2012 by Genadi Samokovarov
+
+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/VERSION

@@ -0,0 +1 @@
+0.1.0

data/carmine.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "carmine"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Genadi Samokovarov"]
+  s.date = "2012-02-28"
+  s.description = "Ruby client for pygmentize.me"
+  s.email = "gsamokovarov@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE",
+    "Rakefile",
+    "Readme.markdown",
+    "VERSION",
+    "carmine.gemspec",
+    "lib/carmine.rb",
+    "lib/carmine/version.rb",
+    "spec/carmine/version_spec.rb",
+    "spec/carmine_spec.rb",
+    "spec/spec_helper.rb",
+    "tasks/gem.rake",
+    "tasks/spec.rake"
+  ]
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby client for pygmentize.me"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end
+

data/lib/carmine.rb

@@ -0,0 +1,105 @@
+require 'httparty'
+
+class Carmine
+  include HTTParty
+
+  # Public: The base error for the library.
+  #
+  # Raised when there is something wrong with the colorization request. 
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def to_s
+      @response.body.match(/\(.*?\)/, &:to_s).gsub(/[()]/, "")
+    end
+  end
+
+  class << self
+    # Public: Delegates the calls to '#colorize', '#pygmentize' and #defaults.
+    #
+    # Examples
+    #
+    #   Carmine.colorize "puts 'Hello World!'", :lexer => :ruby
+    #   Carmine.pygmentize "puts 'Hello World!'", :lexer => :ruby
+    def method_missing(name, *args, &block)
+      if instance.respond_to? name
+        instance.send name, *args, &block
+      else
+        super
+      end
+    end
+
+    private
+
+    def instance
+      @instance ||= new
+    end
+  end
+
+  base_uri 'pygmentize.me'
+
+  # Public: Gets/Sets the client default options.
+  attr_accessor :defaults
+
+  # Public: Initialize the carmine object.
+  #
+  # options - The default options to use when colorizing.
+  #           :formatter (default: :html)
+  #           :lexer     (default: :plain)
+  def initialize(options = {})
+    @defaults = {
+      :formatter => :html,
+      :lexer     => :plain
+    }.merge options
+  end
+
+  # Public: Colorizes the given code using the specified :formatter and :lexer.
+  #
+  # code    - The code to colorize (default: nil).
+  # options - The option passed to the pygmentize.me api, the optinal options
+  #           take their defaults from the hash passed in the constructor.
+  #           :code      - Can be specified here (optional).
+  #           :formatter - The name of the formatter to use (optional).
+  #           :lexer     - The name of the lexer to use (optiona).
+  #
+  # Examples 
+  #
+  #   colorize "puts 'Hello World!'", :lexer => :ruby, :formatter => :text
+  #   # => "puts 'Hello World!'"
+  #
+  #   colorize :code => "puts 'Hello World!'", :lexer => :ruby, :formatter => :text
+  #   # => "puts 'Hello World!'"
+  #
+  # Returns the colorized code.
+  # Yields the colorized code if there is a block given.
+  def colorize(code = nil, options = {})
+    params        = @defaults.merge options
+    params[:code] = code.respond_to?(:read) ? code.read : code unless code.nil?
+
+    raise ArgumentError, "Argument or option :code missing" if params[:code].nil?
+
+    response = post "/api/formatter/#{options[:formatter]}", :query => params
+
+    raise Error, response unless response.success?
+
+    if block_given?
+      yield response.body
+    else
+      response.body
+    end
+  end
+
+  alias :pygmentize :colorize
+
+  private
+
+  def post(path, options = {})
+    self.class.post path, @defaults.merge(options)
+  end
+end
+
+require 'carmine/version'

data/lib/carmine/version.rb

@@ -0,0 +1,15 @@
+class Carmine
+  module Version
+    Major, Minor, Patch =
+      File.read(File.expand_path('../../../VERSION', __FILE__)).split('.')
+  end
+  
+  class << self
+    # Public: The version of the client.
+    #
+    # Returns a String of the dot joined version parts.
+    def version
+      [Version::Major, Version::Minor, Version::Patch].join('.')
+    end
+  end
+end

data/spec/carmine/version_spec.rb

@@ -0,0 +1,7 @@
+describe Carmine::Version do
+  [:Major, :Minor, :Patch].each do |const|
+    it "should have #{const} part constant" do
+      Carmine::Version.constants.should include(const)
+    end
+  end
+end

data/spec/carmine_spec.rb

@@ -0,0 +1,49 @@
+describe Carmine do
+  describe '#initialize' do
+    it 'should accept options used as defaults' do
+      carmine = Carmine.new :lexer => :ruby, :formatter => :latex
+
+      carmine.defaults[:lexer].should     eq(:ruby)
+      carmine.defaults[:formatter].should eq(:latex)
+    end
+  end
+
+  %w{ :: # }.each do |access|
+    describe "#{access}colorize" do
+      let(:carmine) { access == '::' ? Carmine : Carmine.new }
+
+      it 'should colorize code with valid lexer and formatter' do
+        carmine.colorize('puts "Hello World!"', :lexer => :ruby, :formatter => 'html').should ==
+          %Q{<div class="highlight"><pre><span class="nb">puts</span> <span class="s2">&quot;Hello World!&quot;</span>\n</pre></div>\n}
+      end
+
+
+      it 'should throw Carmine::Error on server side errors' do
+        expect {
+          carmine.colorize 'pass', :lexer => :python, :formatter => :invalid
+        }.to raise_error(Carmine::Error)
+      end
+
+      it 'should raise ArgumentError on missing code' do
+        expect { carmine.colorize }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#defaults' do
+    it 'should get or set instance wide default options' do
+      carmine = Carmine.new
+      carmine.defaults = { :lexer => :ruby, :formatter => :latex }
+
+      carmine.defaults[:lexer].should     eq(:ruby)
+      carmine.defaults[:formatter].should eq(:latex)
+    end
+  end
+
+  describe '::version' do
+    it 'should consist of Major, Minor and Patch joined by a dot' do
+      [Carmine::Version::Major, Carmine::Version::Minor, Carmine::Version::Patch].join('.').should \
+        eq(Carmine.version)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'carmine'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.fail_fast = true
+end

data/tasks/gem.rake

@@ -0,0 +1,16 @@
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require 'jeweler'
+require 'carmine/version'
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = 'carmine'
+  gem.version     = Carmine.version
+  gem.email       = 'gsamokovarov@gmail.com'
+  gem.authors     = ['Genadi Samokovarov']
+  gem.license     = 'MIT'
+  gem.summary     = 'Ruby client for pygmentize.me'
+  gem.description = 'Ruby client for pygmentize.me'
+
+  gem.add_dependency 'httparty'
+end

data/tasks/spec.rake

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+desc 'Run the specifiaction examples'
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = %w{-r "spec_helper" --color --format documentation}
+  task.pattern = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: carmine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &12191080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12191080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12186440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12186440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12185540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12185540
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &12182400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12182400
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &12181720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12181720
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &12181060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12181060
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &12180440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12180440
+description: Ruby client for pygmentize.me
+email: gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- Rakefile
+- Readme.markdown
+- VERSION
+- carmine.gemspec
+- lib/carmine.rb
+- lib/carmine/version.rb
+- spec/carmine/version_spec.rb
+- spec/carmine_spec.rb
+- spec/spec_helper.rb
+- tasks/gem.rake
+- tasks/spec.rake
+homepage: 
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby client for pygmentize.me
+test_files: []