buttercms-ruby 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac278c4393b2e128e1bf08b1545d0b398e8d40e5
-  data.tar.gz: 8cee1f47a82ad04e272a15eb8c3a85fdb8ca19f8
+  metadata.gz: 3b1eb7961f35d03a98b64dd179718d91cef63533
+  data.tar.gz: 0a39f2a75b721b3a859b413ffa0f2d91d1528bbb
 SHA512:
-  metadata.gz: 911f9a25ccc98f3673ea0754607a71305ce4dce177c7a88b769a139585f2046a18b0af89adaba4a532b271bcc0c29b61e3b86d179543e0cc41e63e000d38d2b6
-  data.tar.gz: b4327c828a90b1f62fae70e8a05aaacc1e8f0fa7ab756aa956b73204e0517f0e07b6eecf961ae34006a4b0c460b086abbf5d38e274c630e7c30ddcb58bc4874a
+  metadata.gz: 5620747eb99c3e1041106cdef205f259bdd63d8d2cc5fce2aa3af4639ddc2217135c2d707fde892b1a68555d43986ff21af6442ff44aca4f2c091a4bccd243ee
+  data.tar.gz: 1d964a1a8f9554fea737dc4f98b5a86df3902cfa2113f8da607082ae6a5766501494604b57ca70c28d076841bf534c350079dc57619880c02a172fee006836e1

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/buttercms-ruby.gemspec

@@ -14,9 +14,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://buttercms.com/docs"
   s.license = 'MIT'
 
-  s.add_dependency 'httparty', '~> 0.14', '>= 0.14.0'
-
-  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'webmock'
   s.required_ruby_version = '>= 1.9.3'
 

data/lib/buttercms/author.rb

@@ -1,7 +1,7 @@
 module ButterCMS
   class Author < ButterResource
     def self.resource_path
-      "/authors"
+      "/authors/"
     end
   end
 end

data/lib/buttercms/butter_resource.rb

@@ -20,8 +20,10 @@ module ButterCMS
       "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@json)
     end
 
-    def self.endpoint(id = '')
-      resource_path + '/' + id.to_s
+    def self.endpoint(id = nil)
+      # Append trailing slash when id is added to path because
+      # API expects all endpoints to include trailing slashes
+      resource_path + (id ? "#{id}/" : '')
     end
 
     def self.resource_path

data/lib/buttercms/category.rb

@@ -1,7 +1,7 @@
 module ButterCMS
   class Category < ButterResource
     def self.resource_path
-      "/categories"
+      "/categories/"
     end
   end
 end

data/lib/buttercms/content.rb

@@ -15,7 +15,7 @@ module ButterCMS
     def self.fetch(keys = [], options = {})
       params = {keys: keys.join(',')}.merge(options)
 
-      response = ButterCMS.request("/content", params)
+      response = ButterCMS.request("/content/", params)
 
       self.new(response)
     end

data/lib/buttercms/errors.rb

@@ -0,0 +1,9 @@
+module ButterCMS
+  # Error is the top level error raised by ButterCMS
+  class Error < StandardError
+  end
+
+  # NotFound is raised when a resource cannot be found
+  class NotFound < Error
+  end
+end

data/lib/buttercms/feed.rb

@@ -1,7 +1,7 @@
 module ButterCMS
   class Feed < ButterResource
     def self.resource_path
-      "/feeds"
+      "/feeds/"
     end
   end
 end

data/lib/buttercms/post.rb

@@ -1,11 +1,11 @@
 module ButterCMS
   class Post < ButterResource
     def self.resource_path
-      "/posts"
+      "/posts/"
     end
 
     def self.search(query = '', options = {})
-      response = ButterCMS.request('/search', {query: query}.merge(options))
+      response = ButterCMS.request('/search/', {query: query}.merge(options))
 
       self.create_collection(response)
     end

data/lib/buttercms/tag.rb

@@ -1,7 +1,7 @@
 module ButterCMS
   class Tag < ButterResource
     def self.resource_path
-      "/tags"
+      "/tags/"
     end
   end
 end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module ButterCMS
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/buttercms-ruby.rb

@@ -1,19 +1,20 @@
 require 'json'
-require 'httparty'
 require 'ostruct'
 require 'logger'
-
-require_relative 'buttercms/version'
-require_relative 'buttercms/hash_to_object'
-
-require_relative 'buttercms/butter_collection'
-require_relative 'buttercms/butter_resource'
-require_relative 'buttercms/author'
-require_relative 'buttercms/category'
-require_relative 'buttercms/tag'
-require_relative 'buttercms/post'
-require_relative 'buttercms/feed'
-require_relative 'buttercms/content'
+require 'uri'
+require 'net/http'
+
+require "buttercms/errors"
+require 'buttercms/version'
+require 'buttercms/hash_to_object'
+require 'buttercms/butter_collection'
+require 'buttercms/butter_resource'
+require 'buttercms/author'
+require 'buttercms/category'
+require 'buttercms/tag'
+require 'buttercms/post'
+require 'buttercms/feed'
+require 'buttercms/content'
 
 # See https://github.com/jruby/jruby/issues/3113
 if RUBY_VERSION < '2.0.0'
@@ -21,7 +22,7 @@ if RUBY_VERSION < '2.0.0'
 end
 
 module ButterCMS
-  @api_url = 'https://api.buttercms.com/v2'
+  @api_url = URI.parse('https://api.buttercms.com/v2')
 
   class << self
     attr_accessor :api_token
@@ -59,20 +60,35 @@ module ButterCMS
   end
 
   def self.api_request(path, options = {})
-    base_options = {
-      auth_token: api_token
-    }
+    query = options.dup
+    query[:auth_token] ||= api_token
 
     if test_mode
-      base_options[:test] = 1
+      query[:test] = 1
     end
 
-    response = HTTParty.get(
-      @api_url + path,
-      headers: {"User-Agent" => "ButterCMS/#{ButterCMS::VERSION}"},
-      query: options.merge(base_options),
-      verify: false
-    )
+    path = "#{@api_url.path}#{URI.encode(path)}?#{URI.encode_www_form(query)}"
+
+    http_options = {
+      open_timeout: 2.0,
+      read_timeout: 5.0,
+      ssl_timeout:  2.0,
+      use_ssl:      @api_url.scheme == "https",
+    }
+
+    response =
+      Net::HTTP.start(@api_url.host, @api_url.port, http_options) do |http|
+        request = Net::HTTP::Get.new(path)
+        request["User-Agent"] = "ButterCMS/Ruby #{ButterCMS::VERSION}"
+        request["Accept"]     = "application/json"
+
+        http.request(request)
+      end
+
+    case response
+    when Net::HTTPNotFound
+      raise ::ButterCMS::NotFound, JSON.parse(response.body)["detail"]
+    end
 
     response.body
   end
@@ -90,7 +106,7 @@ module ButterCMS
         logger.info "Set key #{key}"
       end
 
-    # TODO - more selective exception handling (RestClient::Exception, SocketError)
+    # TODO - more selective exception handling (SocketError)
     rescue Exception => e
 
       if data_store

data/spec/lib/butter-ruby_spec.rb

@@ -4,12 +4,15 @@ describe ButterCMS do
   describe '.request' do
     context 'with an api token' do
       before do
-        ButterCMS.stub(:api_token).and_return('test123')
+        allow(ButterCMS).to receive(:api_token).and_return('test123')
       end
 
       it 'should make an api request' do
-        stub_request(:get, 'https://api.buttercms.com/v2?auth_token=test123').to_return(body: JSON.generate({data: {test: 'test'}}))
-        expect{ ButterCMS.request('') }.to_not raise_error
+        request = stub_request(:get, "https://api.buttercms.com/v2?auth_token=test123")
+          .to_return(body: JSON.generate({data: {test: 'test'}}))
+
+        ButterCMS.request('')
+        expect(request).to have_been_made
       end
     end
 
@@ -18,5 +21,18 @@ describe ButterCMS do
         expect{ ButterCMS.request() }.to raise_error(ArgumentError)
       end
     end
+
+    it "raises NotFound on 404" do
+      allow(ButterCMS).to receive(:api_token).and_return("test123")
+
+      request = stub_request(:get, %r{/posts/slug/})
+        .with(query: { auth_token: "test123" })
+        .to_return(status: 404, body: '{"detail":"Not found."}')
+
+      expect { ButterCMS.request("/posts/slug/") }
+        .to raise_error(ButterCMS::NotFound)
+
+      expect(request).to have_been_made
+    end
   end
 end

data/spec/lib/buttercms/butter_resource_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe ButterCMS::ButterResource do
-  describe '.all' do
-    before do
-      ButterCMS.stub(:token).and_return('test123')
-      ButterCMS.stub(:request).and_return({"data" => [{"attribute" => 'test'}]})
+  before do
+    allow(ButterCMS).to receive(:token).and_return('test123')
+    allow(ButterCMS).to receive(:request).and_return({"data" => [{"attribute" => 'test'}]})
 
-      ButterCMS::ButterResource.stub(:resource_path).
-        and_return('')
-    end
+    allow(ButterCMS::ButterResource).to receive(:resource_path).and_return('')
+  end
+
+  describe '.all' do
 
     it 'should make a request with the correct endpoint' do
       expect(ButterCMS).to receive(:request).with('/', {})
@@ -23,14 +23,6 @@ describe ButterCMS::ButterResource do
   end
 
   describe '.find' do
-    before do
-      ButterCMS.stub(:token).and_return('test123')
-      ButterCMS.stub(:request).and_return({"data" => {"attribute" => 'test'}})
-
-      ButterCMS::ButterResource.stub(:resource_path).
-        and_return('')
-    end
-
     it 'should make a request with the correct endpoint' do
       expect(ButterCMS).to receive(:request).with('/1', {})
       ButterCMS::ButterResource.find(1)

metadata

@@ -1,61 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: buttercms-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   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: Butter is a blogging platform loved by engineers. See https://buttercms.com
@@ -66,8 +46,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -82,7 +62,7 @@ files:
 - lib/buttercms/content.rb
 - lib/buttercms/data_store_adapters/redis.rb
 - lib/buttercms/data_store_adapters/yaml.rb
-- lib/buttercms/errors/buttercms_error.rb
+- lib/buttercms/errors.rb
 - lib/buttercms/feed.rb
 - lib/buttercms/hash_to_object.rb
 - lib/buttercms/post.rb
@@ -104,17 +84,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the buttercms.com REST API

data/lib/buttercms/errors/buttercms_error.rb

@@ -1,4 +0,0 @@
-module ButterCMS
-  class ButterCMSError < StandardError
-  end
-end