hotchoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 712dd4cc4edbc921ba19da7b36c609597ba489f5
+  data.tar.gz: f5d5f5eefea75d10a73a2f7f95038039d96056a5
+SHA512:
+  metadata.gz: 0bc4281b3606d88dc0c5a7ddd47c7d4a3a60de153938d321a65a57ea5bf277dbbcff93023e6aa24f7e73b01462bdc5b3958b035ceeceb97b552029321e572f8c
+  data.tar.gz: 5d864289c2202cb28ae3cf878e111cfd313ad3c93e569b580956faea2d91ddf4e55310c713f867dce344164f64df9589ea27750a437a83689602877f65038b79

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/.rspec

@@ -0,0 +1 @@
+--colour -b -f d

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthias Siegel
+
+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,43 @@
+# hotchoc-ruby
+
+Official Ruby wrapper for the Hotchoc API (in private beta).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hotchoc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hotchoc
+
+## Usage
+
+### Rails
+
+Add an initializer ```config/initializers/hotchoc.rb``` with your details:
+
+    Hotchoc.configure do |config|
+      config.api_key = 'abcde'      # Your API key
+      config.site = 'mysite'        # Short name of your site
+      config.format = :json         # Can be :json (default) or :xml
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2014 Matthias Siegel. See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/Rakefile

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

data/hotchoc.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hotchoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hotchoc"
+  spec.version       = Hotchoc::VERSION
+  spec.authors       = ["Matthias Siegel"]
+  spec.email         = ["matthias.siegel@gmail.com"]
+  spec.summary       = %q{Official Ruby wrapper for the Hotchoc API.}
+  spec.description   = %q{Official Ruby wrapper for the Hotchoc API.}
+  spec.homepage      = "https://github.com/choc/hotchoc-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hotchoc/client.rb

@@ -0,0 +1,26 @@
+module Hotchoc
+  class Client
+
+    #
+    # Define the same set of accessors as in the Hotchoc module
+    #
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options = {})
+      merged_options = Hotchoc.options.merge(options)
+
+      #
+      # Copy the merged values to this client and ignore those
+      # not part of the configuration.
+      #
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def user_agent
+      @user_agent ||= "Hotchoc gem #{Hotchoc::VERSION}"
+    end
+
+  end
+end

data/lib/hotchoc/configuration.rb

@@ -0,0 +1,41 @@
+module Hotchoc
+  module Configuration
+
+    VALID_CONFIG_KEYS = [:api_key, :site, :hotchoc_hostname, :format].freeze
+
+    DEFAULT_API_KEY = nil
+    DEFAULT_SITE = nil
+    DEFAULT_HOTCHOC_HOSTNAME = 'hotchoc.dev'
+    DEFAULT_FORMAT = :json
+
+    #
+    # Build accessor methods for every config options so we can do this, for example:
+    #
+    #   Hotchoc.format = :xml
+    #
+    attr_accessor *VALID_CONFIG_KEYS
+
+    #
+    # Make sure we have the default values set when we get 'extended'
+    #
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.api_key = DEFAULT_API_KEY
+      self.site = DEFAULT_SITE
+      self.hotchoc_hostname = DEFAULT_HOTCHOC_HOSTNAME
+      self.format = DEFAULT_FORMAT
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[*VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten]
+    end
+
+  end
+end

data/lib/hotchoc/version.rb

@@ -0,0 +1,3 @@
+module Hotchoc
+  VERSION = "0.0.1"
+end

data/lib/hotchoc.rb

@@ -0,0 +1,7 @@
+require 'hotchoc/configuration'
+require 'hotchoc/client'
+require 'hotchoc/version'
+
+module Hotchoc
+  extend Configuration
+end

data/spec/hotchoc/client_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe 'Hotchoc::Client' do
+
+  before do
+    @keys = Hotchoc::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+
+    before do
+      Hotchoc.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Hotchoc.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Hotchoc::Client.new
+
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    describe 'with class configuration' do
+
+      before do
+        @config = {
+          api_key: 'abc',
+          site: 'def',
+          hotchoc_hostname: 'ghi',
+          format: 'jkl'
+        }
+      end
+
+      it 'should override module configuration' do
+        api = Hotchoc::Client.new(@config)
+
+        @keys.each do |key|
+          api.send(key).should == @config[key]
+        end
+      end
+
+      it 'should override module configuration after' do
+        api = Hotchoc::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+
+        @keys.each do |key|
+          api.send("#{key}").should == @config[key]
+        end
+      end
+    end
+  end
+
+  describe ".user_agent" do
+
+    it "should return the user agent with the current version" do
+      Hotchoc::Client.new.user_agent.should == "Hotchoc gem #{Hotchoc::VERSION}"
+    end
+  end
+
+end

data/spec/hotchoc/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'Hotchoc::Configuration' do
+
+  after do
+    Hotchoc.reset
+  end
+
+  Hotchoc::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ".#{key}" do
+      it "should return the default #{key}" do
+        Hotchoc.send(key).should == Hotchoc::Configuration.const_get("DEFAULT_#{key.upcase}")
+      end
+    end
+  end
+
+  describe '.configure' do
+
+    Hotchoc::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do
+        Hotchoc.configure do |config|
+          config.send("#{key}=", key)
+          Hotchoc.send(key).should == key
+        end
+      end
+    end
+  end
+end

data/spec/hotchoc/main_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Hotchoc' do
+
+  it 'should have a version' do
+    Hotchoc::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'hotchoc'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: hotchoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthias Siegel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official Ruby wrapper for the Hotchoc API.
+email:
+- matthias.siegel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- hotchoc.gemspec
+- lib/hotchoc.rb
+- lib/hotchoc/client.rb
+- lib/hotchoc/configuration.rb
+- lib/hotchoc/version.rb
+- spec/hotchoc/client_spec.rb
+- spec/hotchoc/configuration_spec.rb
+- spec/hotchoc/main_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/choc/hotchoc-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Official Ruby wrapper for the Hotchoc API.
+test_files:
+- spec/hotchoc/client_spec.rb
+- spec/hotchoc/configuration_spec.rb
+- spec/hotchoc/main_spec.rb
+- spec/spec_helper.rb