hotchoc 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 712dd4cc4edbc921ba19da7b36c609597ba489f5
-  data.tar.gz: f5d5f5eefea75d10a73a2f7f95038039d96056a5
+  metadata.gz: 772df776e809aa41302d368813a4378aed3f4cc0
+  data.tar.gz: 060a43cfd5352ab0ac2ee6aa7e637efc28c5314f
 SHA512:
-  metadata.gz: 0bc4281b3606d88dc0c5a7ddd47c7d4a3a60de153938d321a65a57ea5bf277dbbcff93023e6aa24f7e73b01462bdc5b3958b035ceeceb97b552029321e572f8c
-  data.tar.gz: 5d864289c2202cb28ae3cf878e111cfd313ad3c93e569b580956faea2d91ddf4e55310c713f867dce344164f64df9589ea27750a437a83689602877f65038b79
+  metadata.gz: 0485bb80b24c5520f951394ecb880214f89ab800a27d2d2d01bbf5350c9a3bb172622fa5a12f3f51ea7f119a144b12a68d6c545f07e8fdc154aae4529f9644dd
+  data.tar.gz: 8ef2d166f82a28e3f67ade1a05f2d68cc93acacce629a00b2ba0ec713a34ad19ddd9d68007ae13ff05fb98f238e8f3ab2246b6d9861a76d9c72293e2bba15486

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 0.1.0
+
+[Full changelog](https://github.com/choc/hotchoc-ruby/compare/v0.0.1...v0.1.0)
+
+Major changes:
+
+* Require authenticated requests
+* Removed format option
+
+Enhancements:
+
+* Basic GET support for albums, pages, posts and topics API
+
+## 0.0.1
+
+Initial release.

data/README.md

@@ -12,21 +12,46 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it manually as:
 
     $ gem install hotchoc
 
 ## Usage
 
-### Rails
+    client = Hotchoc::Client.new(
+      api_key: 'abcde',      # Your API key
+      site: 'mysite'         # Short name of your site
+    )
 
-Add an initializer ```config/initializers/hotchoc.rb``` with your details:
+## Examples
 
-    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
+    # Get single album by ID
+    client.get_album('53d0dcdc6c6f725407000000')
+    => {"id"=>"53d0dcdc6c6f725407000000", "title"=>"New album", "subtitle"=>"A subtitle", ...
+
+    # Get all albums
+    client.get_albums
+    => [{"id"=>"53d0dcdc6c6f725407000000", "title"=>"New album", "subtitle"=>"A subtitle", ...
+
+    # Get only first 10 albums
+    client.get_albums(limit: 10)
+    => [{"id"=>"53d0dcdc6c6f725407000000", "title"=>"New album", "subtitle"=>"A subtitle", ...
+
+## API
+
+### Get single resource
+
+    client.get_album(id)
+    client.get_page(id)
+    client.get_post(id)
+    client.get_topic(id)
+
+### Get collection
+
+    client.get_albums
+    client.get_pages
+    client.get_posts
+    client.get_topics
 
 ## Contributing
 
@@ -40,4 +65,9 @@ Add an initializer ```config/initializers/hotchoc.rb``` with your details:
 
 Copyright (c) 2014 Matthias Siegel. See [LICENSE][] for details.
 
+## Changelog
+
+See [CHANGELOG][] for details.
+
 [license]: LICENSE.md
+[changelog]: CHANGELOG.md

data/hotchoc.gemspec

@@ -16,7 +16,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "typhoeus", "~> 0.6.9"
+
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.18"
 end

data/lib/hotchoc/api.rb

@@ -0,0 +1,45 @@
+module Hotchoc
+  module API
+
+    def get_album(id)
+      raise ArgumentError, "Album ID is required" unless id
+
+      get("albums/#{id}")['album']
+    end
+
+    def get_albums(opts = {})
+      get("albums", opts)['albums']
+    end
+
+    def get_page(id)
+      raise ArgumentError, "Page ID is required" unless id
+
+      get("pages/#{id}")['page']
+    end
+
+    def get_pages(opts = {})
+      get("pages", opts)['pages']
+    end
+
+    def get_post(id)
+      raise ArgumentError, "Post ID is required" unless id
+
+      get("posts/#{id}")['post']
+    end
+
+    def get_posts(opts = {})
+      get("posts", opts)['posts']
+    end
+
+    def get_topic(id)
+      raise ArgumentError, "Topic ID is required" unless id
+
+      get("topics/#{id}")['topic']
+    end
+
+    def get_topics(opts = {})
+      get("topics", opts)['topics']
+    end
+
+  end
+end

data/lib/hotchoc/client.rb

@@ -1,26 +1,37 @@
 module Hotchoc
   class Client
+    include Hotchoc::API
 
     #
     # 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)
+    def initialize(opts = {})
+      options = Hotchoc.options.merge(opts)
+
+      raise ArgumentError, "API key is required" unless options[:api_key]
+      raise ArgumentError, "Site name is required" unless options[:site]
 
       #
       # 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])
+        send("#{key}=", options[key])
       end
     end
 
-    def user_agent
-      @user_agent ||= "Hotchoc gem #{Hotchoc::VERSION}"
+    private
+
+    def get(path, opts = {})
+      url = "https://#{site}.#{hostname}/api/#{path}"
+
+      Fetcher.get(url, merged_options(opts), verify)
     end
 
+    def merged_options(opts)
+      { api_key: api_key }.merge(opts)
+    end
   end
 end

data/lib/hotchoc/configuration.rb

@@ -1,17 +1,17 @@
 module Hotchoc
   module Configuration
 
-    VALID_CONFIG_KEYS = [:api_key, :site, :hotchoc_hostname, :format].freeze
+    VALID_CONFIG_KEYS = [:api_key, :site, :hostname, :verify].freeze
 
     DEFAULT_API_KEY = nil
     DEFAULT_SITE = nil
-    DEFAULT_HOTCHOC_HOSTNAME = 'hotchoc.dev'
-    DEFAULT_FORMAT = :json
+    DEFAULT_HOSTNAME = 'hotchoc.io'
+    DEFAULT_VERIFY = true
 
     #
     # Build accessor methods for every config options so we can do this, for example:
     #
-    #   Hotchoc.format = :xml
+    #   Hotchoc.site = 'mattdownunder'
     #
     attr_accessor *VALID_CONFIG_KEYS
 
@@ -25,17 +25,12 @@ module Hotchoc
     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
+      self.hostname = DEFAULT_HOSTNAME
+      self.verify = DEFAULT_VERIFY
     end
 
     def options
       Hash[*VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten]
     end
-
   end
 end

data/lib/hotchoc/errors.rb

@@ -0,0 +1,12 @@
+module Hotchoc
+  module Errors
+
+    # Base error class for all custom errors
+    class HotchocError < StandardError
+    end
+
+    class RequestError < HotchocError
+    end
+
+  end
+end

data/lib/hotchoc/fetcher.rb

@@ -0,0 +1,35 @@
+require 'typhoeus'
+require 'json'
+
+module Hotchoc
+  class Fetcher
+
+    DEFAULT_OPTIONS = {
+      headers: {
+        Accept: "application/json",
+        "User-Agent" => "Hotchoc Ruby #{Hotchoc::VERSION}"
+      },
+      followlocation: true,
+      accept_encoding: 'gzip'
+    }
+
+    def self.get(url, opts, verify)
+      request = Typhoeus::Request.new(url, {
+        method: :get,
+        params: opts,
+        ssl_verifypeer: verify
+      }.merge(DEFAULT_OPTIONS))
+
+      request.on_complete do |response|
+        if response.timed_out?
+          raise Hotchoc::Errors::RequestError, "Request timed out"
+        elsif !response.success?
+          raise Hotchoc::Errors::RequestError, "Request failed, code #{response.code}, message: #{response.return_message}"
+        end
+      end
+
+      JSON.parse(request.run.body)
+    end
+
+  end
+end

data/lib/hotchoc/version.rb

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

data/lib/hotchoc.rb

@@ -1,3 +1,6 @@
+require 'hotchoc/errors'
+require 'hotchoc/api'
+require 'hotchoc/fetcher'
 require 'hotchoc/configuration'
 require 'hotchoc/client'
 require 'hotchoc/version'

data/spec/hotchoc/api_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe 'Hotchoc::API' do
+
+  let(:client) do
+    Hotchoc::Client.new({
+      api_key: 'test',
+      site: 'test'
+    })
+  end
+
+  describe 'Albums' do
+
+    context 'GET single item' do
+      let(:album) do
+        JSON.parse(File.read(response_stub('album')))['album']
+      end
+
+      it "returns a hash with the album" do
+        expect(client.get_album('53d3a2266c6f72785d010000')).to eq album
+      end
+    end
+
+    context 'GET collection' do
+      let(:albums) do
+        JSON.parse(File.read(response_stub('albums')))['albums']
+      end
+
+      it "returns an array with the albums" do
+        expect(client.get_albums).to eq albums
+      end
+    end
+  end
+
+  describe 'Pages' do
+
+    context 'GET single item' do
+      let(:page) do
+        JSON.parse(File.read(response_stub('page')))['page']
+      end
+
+      it "returns a hash with the page" do
+        expect(client.get_page('53d3a6ee6c6f72785d260000')).to eq page
+      end
+    end
+
+    context 'GET collection' do
+      let(:pages) do
+        JSON.parse(File.read(response_stub('pages')))['pages']
+      end
+
+      it "returns an array with the pages" do
+        expect(client.get_pages).to eq pages
+      end
+    end
+  end
+
+  describe 'Posts' do
+
+    context 'GET single item' do
+      let(:post) do
+        JSON.parse(File.read(response_stub('post')))['post']
+      end
+
+      it "returns a hash with the post" do
+        expect(client.get_post('53d3a7596c6f72785d290000')).to eq post
+      end
+    end
+
+    context 'GET collection' do
+      let(:posts) do
+        JSON.parse(File.read(response_stub('posts')))['posts']
+      end
+
+      it "returns an array with the posts" do
+        expect(client.get_posts).to eq posts
+      end
+    end
+  end
+
+  describe 'Topics' do
+
+    context 'GET single item' do
+      let(:topic) do
+        JSON.parse(File.read(response_stub('topic')))['topic']
+      end
+
+      it "returns a hash with the topic" do
+        expect(client.get_topic('53d0dca56c6f7253e6060000')).to eq topic
+      end
+    end
+
+    context 'GET collection' do
+      let(:topics) do
+        JSON.parse(File.read(response_stub('topics')))['topics']
+      end
+
+      it "returns an array with the topics" do
+        expect(client.get_topics).to eq topics
+      end
+    end
+  end
+end

data/spec/hotchoc/client_spec.rb

@@ -6,66 +6,34 @@ describe 'Hotchoc::Client' do
     @keys = Hotchoc::Configuration::VALID_CONFIG_KEYS
   end
 
-  describe 'with module configuration' do
-
+  describe 'with class configuration' do
     before do
-      Hotchoc.configure do |config|
-        @keys.each do |key|
-          config.send("#{key}=", key)
-        end
-      end
-    end
-
-    after do
-      Hotchoc.reset
+      @config = {
+        api_key: 'abc',
+        site: 'def',
+        hostname: 'ghi',
+        verify: false
+      }
     end
 
-    it "should inherit module configuration" do
-      api = Hotchoc::Client.new
+    it 'should override module configuration' do
+      client = Hotchoc::Client.new(@config)
 
       @keys.each do |key|
-        api.send(key).should == key
+        expect(client.send(key)).to eq @config[key]
       end
     end
 
-    describe 'with class configuration' do
+    it 'should override module configuration after' do
+      client = Hotchoc::Client.new(api_key: 'rst', site: 'uvw', hostname: 'xyz', verify: true)
 
-      before do
-        @config = {
-          api_key: 'abc',
-          site: 'def',
-          hotchoc_hostname: 'ghi',
-          format: 'jkl'
-        }
+      @config.each do |key, value|
+        client.send("#{key}=", value)
       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
+      @keys.each do |key|
+        expect(client.send("#{key}")).to eq @config[key]
       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

@@ -9,19 +9,7 @@ describe 'Hotchoc::Configuration' do
   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
+        expect(Hotchoc.send(key)).to eq Hotchoc::Configuration.const_get("DEFAULT_#{key.upcase}")
       end
     end
   end

data/spec/hotchoc/main_spec.rb

@@ -3,6 +3,6 @@ require 'spec_helper'
 describe 'Hotchoc' do
 
   it 'should have a version' do
-    Hotchoc::VERSION.should_not be_nil
+    expect(Hotchoc::VERSION).to_not be_nil
   end
 end

data/spec/spec_helper.rb

@@ -2,9 +2,13 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'hotchoc'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+Dir.glob("#{File.dirname(__FILE__)}/support/**/*.rb").each { |f| require f }
 
 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
 

data/spec/support/helpers.rb

@@ -0,0 +1,3 @@
+def response_stub(name)
+  "#{File.dirname(__FILE__)}/responses/#{name}.json"
+end