hotchoc 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6755f8467bd572a215a91f2e359ed6bf044b256d
-  data.tar.gz: 4a36c9752a34f42825a92413cac48e332f4d721f
+  metadata.gz: c9e5cbbe0a4ac84c3a34276088b1ee8f99bdb4d6
+  data.tar.gz: 23957659ecc09f31f748b56b3117316ba7d9d22f
 SHA512:
-  metadata.gz: ab36bffd5983e96eb34ea1b49243bce98cb4e624e537456a403cadf0d8b0488f829b8d63a3dd2bf44b225d54d16bcf0dbe184b51890cc1c47c6fdc0a1032eedb
-  data.tar.gz: e21c2248d0665fbd209833e2d249ca64c9dfb338173a334f7bdba9253ebc0b21eec4b9d81e9d7a08713743a668018d34da2c7f8a6013b61ecb8697a265df171d
+  metadata.gz: 56bace741611ecb19ef9e10ca7e5120c61936b257bdbd07271599887ccda5ddcbc05722f19ea96e8e00b6e03382e97b0ae62fac72be74ea458d7917a0a4ed4c8
+  data.tar.gz: f57a0c75eee90516efc980ec3eef3bfb034216011f456083b7c19e49147f938f4bb51743c9f9f1531109f10ab246ce6169490241fb12e10edb1b5de2d8c436af

data/.ruby-gemset

@@ -0,0 +1 @@
+hotchoc

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master
 
+## 0.3.0
+
+[Full changelog](https://github.com/choc/hotchoc-ruby/compare/v0.2.1...v0.3.0)
+
+Changes:
+
+* Internal code reorganisation
+* Switched from Typhoeus to HTTParty
+
 ## 0.2.1
 
 [Full changelog](https://github.com/choc/hotchoc-ruby/compare/v0.2.0...v0.2.1)

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Matthias Siegel
+Copyright (c) 2014-2015 Matthias Siegel
 
 MIT License
 

data/README.md

@@ -1,9 +1,10 @@
-# hotchoc-ruby
+# hotchoc
 
 Ruby wrapper for the Hotchoc API (in private beta).
 
+[![Codeship Status for choc/hotchoc-ruby](https://codeship.com/projects/954557c0-e9a3-0132-ab76-56071da69c74/status?branch=master)](https://codeship.com/projects/82979)
 [![Gem Version](https://badge.fury.io/rb/hotchoc.svg)](http://badge.fury.io/rb/hotchoc)
-[![Code Climate](https://codeclimate.com/github/choc/hotchoc-ruby.png)](https://codeclimate.com/github/choc/hotchoc-ruby)
+[![Code Climate](https://codeclimate.com/github/choc/hotchoc/badges/gpa.svg)](https://codeclimate.com/github/choc/hotchoc)
 
 ## Installation
 

data/Rakefile

@@ -1,9 +1,4 @@
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
+require 'bundler/gem_tasks'
 
-desc 'Run RuboCop checks'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['{lib,spec}/**/*.rb']
-  task.formatters = ['progress']
-  task.fail_on_error = true
-end
+spec = Gem::Specification.find_by_name('lint')
+load "#{spec.gem_dir}/lib/tasks/lint.rake"

data/hotchoc.gemspec

@@ -1,10 +1,11 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hotchoc/version'
+
+require 'hotchoc/client/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'hotchoc'
-  spec.version       = Hotchoc::VERSION
+  spec.version       = Hotchoc::Client::VERSION
   spec.authors       = ['Matthias Siegel']
   spec.email         = ['matthias.siegel@gmail.com']
   spec.summary       = %q{Ruby wrapper for the Hotchoc API.}
@@ -16,13 +17,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'typhoeus', '~> 0.7.0'
+  spec.add_dependency 'httparty', '~> 0.13'
 
   spec.add_development_dependency 'binding_of_caller', '~> 0.7.2'
   spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'lint', '~> 0.3'
   spec.add_development_dependency 'pry', '~> 0.10.1'
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 0.24.1'
   spec.add_development_dependency 'webmock', '~> 1.20'
 end

data/lib/hotchoc/client/api.rb

@@ -0,0 +1,21 @@
+module Hotchoc
+  class Client
+    module API
+      def get_albums(opts = {})
+        get('albums', opts)['albums'].map { |album| Hotchoc::Presenters::Album.new(album) }
+      end
+
+      def get_pages(opts = {})
+        get('pages', opts)['pages'].map { |page| Hotchoc::Presenters::Page.new(page) }
+      end
+
+      def get_posts(opts = {})
+        get('posts', opts)['posts'].map { |post| Hotchoc::Presenters::Post.new(post) }
+      end
+
+      def get_topics(opts = {})
+        get('topics', opts)['topics'].map { |topic| Hotchoc::Presenters::Topic.new(topic) }
+      end
+    end
+  end
+end

data/lib/hotchoc/client/configuration.rb

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

data/lib/hotchoc/client/errors.rb

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

data/lib/hotchoc/client/fetcher.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+require 'json'
+
+module Hotchoc
+  class Client
+    class Fetcher
+      DEFAULT_OPTIONS = {
+        headers: {
+          'Accept' => 'application/json',
+          'Accept-Encoding' => 'gzip',
+          'User-Agent' => "Hotchoc Ruby client #{Hotchoc::Client::VERSION}"
+        },
+        follow_redirects: true
+      }
+
+      def self.get(url, opts = {}, verify = true)
+        new.get(url, opts, verify)
+      end
+
+      def get(url, opts = {}, verify = true)
+        response = HTTParty.get(url, params(opts, verify))
+
+        if response.success?
+          JSON.parse(response.body)
+        else
+          fail Errors::RequestError, request_error_message(response)
+        end
+      end
+
+      private
+
+      def params(opts, verify)
+        {
+          query: opts,
+          verify: verify
+        }.merge(DEFAULT_OPTIONS)
+      end
+
+      def request_error_message(response)
+        "Request failed with code #{response.code}. #{response.message}"
+      end
+    end
+  end
+end

data/lib/hotchoc/client/version.rb

@@ -0,0 +1,5 @@
+module Hotchoc
+  class Client
+    VERSION = '0.3.0'
+  end
+end

data/lib/hotchoc/client.rb

@@ -1,17 +1,17 @@
 module Hotchoc
   class Client
-    include Hotchoc::API
+    include API
 
     #
     # Define the same set of accessors as in the Hotchoc module
     #
-    attr_accessor *Configuration::VALID_CONFIG_KEYS
+    attr_accessor(*Configuration::VALID_CONFIG_KEYS)
 
     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]
+      fail ArgumentError, 'API key is required' unless options[:api_key]
+      fail ArgumentError, 'Site name is required' unless options[:site]
 
       #
       # Copy the merged values to this client and ignore those

data/lib/hotchoc/presenters/album.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class Album < Hotchoc::Presenters::Base
-
       def id
         @item['id']
       end
@@ -54,8 +52,6 @@ module Hotchoc
       def inspect
         %(#<Hotchoc::Presenters::Album: title="#{title}">)
       end
-
     end
-
   end
 end

data/lib/hotchoc/presenters/base.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class Base
-
       attr_reader :item
 
       def initialize(item = {})
@@ -19,8 +17,6 @@ module Hotchoc
           Hotchoc::Presenters::Blocks::Image.new(block)
         end
       end
-
     end
-
   end
 end

data/lib/hotchoc/presenters/blocks/base.rb

@@ -1,9 +1,7 @@
 module Hotchoc
   module Presenters
     module Blocks
-
       class Base < Hotchoc::Presenters::Base
-
         def id
           @item['id']
         end
@@ -23,9 +21,7 @@ module Hotchoc
         def updated_at
           Time.parse(@item['updated_at'])
         end
-
       end
-
     end
   end
 end

data/lib/hotchoc/presenters/blocks/image.rb

@@ -1,9 +1,7 @@
 module Hotchoc
   module Presenters
     module Blocks
-
       class Image < Hotchoc::Presenters::Blocks::Base
-
         def title
           @item['content']['title']
         end
@@ -15,9 +13,7 @@ module Hotchoc
         def inspect
           %(#<Hotchoc::Presenters::Blocks::Image: title="#{title}" position="#{position}">)
         end
-
       end
-
     end
   end
 end

data/lib/hotchoc/presenters/blocks/text.rb

@@ -1,9 +1,7 @@
 module Hotchoc
   module Presenters
     module Blocks
-
       class Text < Hotchoc::Presenters::Blocks::Base
-
         def markdown
           @item['content']['markdown']
         end
@@ -15,9 +13,7 @@ module Hotchoc
         def inspect
           %(#<Hotchoc::Presenters::Blocks::Text: position="#{position}">)
         end
-
       end
-
     end
   end
 end

data/lib/hotchoc/presenters/file.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class File < Hotchoc::Presenters::Base
-
       def id
         @item['id']
       end
@@ -34,7 +32,7 @@ module Hotchoc
       def thumbnails
         if @item['thumbnails']
           @item['thumbnails']['original'].map { |thumbnail| Hotchoc::Presenters::Thumbnail.new(thumbnail) } +
-          @item['thumbnails']['square'].map { |thumbnail| Hotchoc::Presenters::Thumbnail.new(thumbnail) }
+            @item['thumbnails']['square'].map { |thumbnail| Hotchoc::Presenters::Thumbnail.new(thumbnail) }
         else
           []
         end
@@ -55,8 +53,6 @@ module Hotchoc
       def inspect
         %(#<Hotchoc::Presenters::File: name="#{name}">)
       end
-
     end
-
   end
 end

data/lib/hotchoc/presenters/page.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class Page < Hotchoc::Presenters::Base
-
       def id
         @item['id']
       end
@@ -62,8 +60,6 @@ module Hotchoc
       def inspect
         %(#<Hotchoc::Presenters::Page: title="#{title}">)
       end
-
     end
-
   end
 end

data/lib/hotchoc/presenters/post.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class Post < Hotchoc::Presenters::Base
-
       def id
         @item['id']
       end
@@ -46,8 +44,6 @@ module Hotchoc
       def inspect
         %(#<Hotchoc::Presenters::Post: title="#{title}">)
       end
-
     end
-
   end
 end

data/lib/hotchoc/presenters/thumbnail.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class Thumbnail < Hotchoc::Presenters::Base
-
       def name
         @item['name']
       end
@@ -30,8 +28,6 @@ module Hotchoc
       def inspect
         %(#<Hotchoc::Presenters::Thumbnail:>)
       end
-
     end
-
   end
 end

data/lib/hotchoc/presenters/topic.rb

@@ -1,8 +1,6 @@
 module Hotchoc
   module Presenters
-
     class Topic < Hotchoc::Presenters::Base
-
       def id
         @item['id']
       end
@@ -26,8 +24,6 @@ module Hotchoc
       def inspect
         %(#<Hotchoc::Presenters::Topic: name="#{name}">)
       end
-
     end
-
   end
 end

data/lib/hotchoc.rb

@@ -9,13 +9,13 @@ require 'hotchoc/presenters/post'
 require 'hotchoc/presenters/thumbnail'
 require 'hotchoc/presenters/topic'
 
-require 'hotchoc/version'
-require 'hotchoc/errors'
-require 'hotchoc/api'
-require 'hotchoc/fetcher'
-require 'hotchoc/configuration'
+require 'hotchoc/client/version'
+require 'hotchoc/client/errors'
+require 'hotchoc/client/api'
+require 'hotchoc/client/fetcher'
+require 'hotchoc/client/configuration'
 require 'hotchoc/client'
 
 module Hotchoc
-  extend Configuration
+  extend Client::Configuration
 end

data/spec/hotchoc/{api_spec.rb → client/api_spec.rb}

@@ -1,61 +1,56 @@
 require 'spec_helper'
 
-describe 'Hotchoc::API' do
-
+describe 'Hotchoc::Client::API' do
   let(:client) do
-    Hotchoc::Client.new({
+    Hotchoc::Client.new(
       api_key: 'test',
       site: 'test'
-    })
+    )
   end
 
   describe 'Albums' do
-
     context 'GET collection' do
       let(:albums) do
         JSON.parse(File.read(response_stub('albums')))['albums'].map { |album| Hotchoc::Presenters::Album.new(album) }
       end
 
-      it "returns an array with the albums" do
+      it 'returns an array with the albums' do
         expect(client.get_albums).to have_the_same_items_as albums
       end
     end
   end
 
   describe 'Pages' do
-
     context 'GET collection' do
       let(:pages) do
         JSON.parse(File.read(response_stub('pages')))['pages'].map { |page| Hotchoc::Presenters::Page.new(page) }
       end
 
-      it "returns an array with the pages" do
+      it 'returns an array with the pages' do
         expect(client.get_pages).to have_the_same_items_as pages
       end
     end
   end
 
   describe 'Posts' do
-
     context 'GET collection' do
       let(:posts) do
         JSON.parse(File.read(response_stub('posts')))['posts'].map { |post| Hotchoc::Presenters::Post.new(post) }
       end
 
-      it "returns an array with the posts" do
+      it 'returns an array with the posts' do
         expect(client.get_posts).to have_the_same_items_as posts
       end
     end
   end
 
   describe 'Topics' do
-
     context 'GET collection' do
       let(:topics) do
         JSON.parse(File.read(response_stub('topics')))['topics'].map { |topic| Hotchoc::Presenters::Topic.new(topic) }
       end
 
-      it "returns an array with the topics" do
+      it 'returns an array with the topics' do
         expect(client.get_topics).to have_the_same_items_as topics
       end
     end

data/spec/hotchoc/client/configuration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Hotchoc::Client::Configuration' do
+  after do
+    Hotchoc.reset
+  end
+
+  Hotchoc::Client::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ".#{key}" do
+      it "should return the default #{key}" do
+        expect(Hotchoc.send(key)).to eq Hotchoc::Client::Configuration.const_get("DEFAULT_#{key.upcase}")
+      end
+    end
+  end
+end

data/spec/hotchoc/{main_spec.rb → client/main_spec.rb}

@@ -1,8 +1,7 @@
 require 'spec_helper'
 
 describe 'Hotchoc' do
-
   it 'should have a version' do
-    expect(Hotchoc::VERSION).to_not be_nil
+    expect(Hotchoc::Client::VERSION).to_not be_nil
   end
 end

data/spec/hotchoc/client_spec.rb

@@ -1,9 +1,8 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Client' do
-
   before do
-    @keys = Hotchoc::Configuration::VALID_CONFIG_KEYS
+    @keys = Hotchoc::Client::Configuration::VALID_CONFIG_KEYS
   end
 
   describe 'with class configuration' do

data/spec/hotchoc/presenters/album_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Presenters::Album' do
-
   let(:data) do
     JSON.parse(File.read(response_stub('albums')))['albums'].first
   end
@@ -59,5 +58,4 @@ describe 'Hotchoc::Presenters::Album' do
   it 'has an updated_at' do
     expect(album.updated_at).to be_a(Time)
   end
-
 end

data/spec/hotchoc/presenters/blocks/image_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Presenters::Blocks::Image' do
-
   let(:data) do
     JSON.parse(File.read(response_stub('albums')))['albums'].first['blocks'].first
   end
@@ -17,5 +16,4 @@ describe 'Hotchoc::Presenters::Blocks::Image' do
   it 'has an image' do
     expect(block.image).to be_a(Hotchoc::Presenters::File)
   end
-
 end

data/spec/hotchoc/presenters/blocks/text_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Presenters::Blocks::Text' do
-
   let(:data) do
     blocks = JSON.parse(File.read(response_stub('pages')))['pages'].first['blocks']
     blocks.detect { |block| block['type'] == 'text' }
@@ -18,5 +17,4 @@ describe 'Hotchoc::Presenters::Blocks::Text' do
   it 'has a markdown version' do
     expect(block.markdown).to be
   end
-
 end

data/spec/hotchoc/presenters/file_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Presenters::File' do
-
   let(:data) do
     JSON.parse(File.read(response_stub('albums')))['albums'].first['blocks'].first
   end
@@ -54,5 +53,4 @@ describe 'Hotchoc::Presenters::File' do
   it 'has an updated_at' do
     expect(file.updated_at).to be_a(Time)
   end
-
 end

data/spec/hotchoc/presenters/page_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Presenters::Page' do
-
   let(:data) do
     JSON.parse(File.read(response_stub('pages')))['pages'].first
   end
@@ -67,5 +66,4 @@ describe 'Hotchoc::Presenters::Page' do
   it 'has an updated_at' do
     expect(page.updated_at).to be_a(Time)
   end
-
 end

data/spec/hotchoc/presenters/post_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Hotchoc::Presenters::Post' do
-
   let(:data) do
     JSON.parse(File.read(response_stub('posts')))['posts'].first
   end
@@ -51,5 +50,4 @@ describe 'Hotchoc::Presenters::Post' do
   it 'has an updated_at' do
     expect(post.updated_at).to be_a(Time)
   end
-
 end