wp-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be8b365075e87e981f79e61c1a7e766cd93d078b
-  data.tar.gz: 4c59262402ba39fa3ab8ce90e6d05b24c3b285b7
+  metadata.gz: e47781bfa7510821225aeb90053dab50a11b7579
+  data.tar.gz: 74a354808fa1138efa2fcb3ee7a43312c1467ef7
 SHA512:
-  metadata.gz: f2658d1c1d13e70bcdcaf28858a8c21c8b980b7a3413df509e99683cb8ab6b9a7274d92005cbd4afffb010341575fc34f67fafee91b1a3c80b3c4057939da8bd
-  data.tar.gz: c55d99f6ff6c9fd6aa2d5c0c58d203dbbe664f7a681f5baa0d142464caf94b6e90c92b0cd5dd3745f3e56840df753b79deb25ce711847e2ec01359095c7e1778
+  metadata.gz: b9d09030d433e7a192488d991ffa4df5bb7805d90817e82fea9e0d7377dae30b432c025c0df98f9ed05569ec34e6daccb8975e5ff0d1e09650370205ee0b1c6c
+  data.tar.gz: b653ec85e6228bf9c61fa0a40d61a788e56977f6856128917d4f713f0995000a2463ae2fff1f20588541d4f4a571adc73872f33305bb1a21ac81c7f0f61d6f9b

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/README.md

@@ -1,5 +1,7 @@
 # WP::API
 
+[![Circle CI](https://circleci.com/gh/colinyoung/wp-api.png?style=badge)](https://circleci.com/gh/colinyoung/wp-api)
+
 Makes it incredibly easy and semantic to access Wordpress blogs that have the new, RESTful WP API plugin installed.
 
 ## Installation
@@ -7,6 +9,10 @@ Makes it incredibly easy and semantic to access Wordpress blogs that have the ne
     gem 'wp-api'
     bundle
 
+## Note
+
+This gem requires Ruby 2.0, which is the [oldest currently supported version of Ruby](https://www.ruby-lang.org/en/news/2014/07/01/eol-for-1-8-7-and-1-9-2/).
+
 ## Usage
 
 ```ruby
@@ -22,3 +28,4 @@ client.users
 ## Author
 
 @colinyoung
+

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.1.2

data/lib/wp/api/client.rb

@@ -1,5 +1,4 @@
 require 'httparty'
-require 'yajl'
 require 'addressable/uri'
 require 'wp/api/endpoints'
 
@@ -20,8 +19,12 @@ module WP::API
 
     def get(resource, query = {})
       path = url_for(resource, query)
-      body = Client.get(path).body
-      parse(body)
+      response = Client.get(path)
+      if response.empty?
+        raise WP::API::ResourceNotFoundError
+      else
+        [ response.parsed_response, response.headers ] # Already parsed.
+      end
     end
 
     private
@@ -35,13 +38,13 @@ module WP::API
 
     def params(query)
       uri = Addressable::URI.new
-      uri.query_values = query
-      uri.query
-    end
+      filter_hash = {}
+      query.each do |key, value|
+        filter_hash["filter[#{key}]"] = value
+      end
+      uri.query_values = filter_hash
 
-    def parse(string)
-      @parser ||= Yajl::Parser.new
-      @parser.parse(string)
+      uri.query
     end
   end
 end

data/lib/wp/api/endpoints.rb

@@ -2,14 +2,18 @@ module WP::API
   module Endpoints
 
     def posts(query = {})
-      get("posts", query).collect do |hash|
-        Post.new(hash)
+      posts, headers = get("posts", query)
+      posts.collect do |hash|
+        WP::API::Post.new(hash, headers)
       end
     end
 
     def post(id, query = {})
-      hash = get("posts/#{id}", query)
-      Post.new(hash)
+      WP::API::Post.new *get("posts/#{id}", query)
+    end
+
+    def post_named(slug)
+      WP::API::Post.new *get("posts", name: slug).first
     end
 
   end

data/lib/wp/api/errors.rb

@@ -0,0 +1,3 @@
+module WP::API
+  class ResourceNotFoundError < Exception; end
+end

data/lib/wp/api/resource.rb

@@ -1,15 +1,18 @@
 require 'active_support/inflector'
+require 'pry'
 
 module WP::API
   class Resource
-    attr_reader :attributes
+    attr_reader :attributes, :headers
 
-    def initialize(attributes)
+    def initialize(attributes, headers = {})
+      raise ResourceNotFoundError.new(self.class.name) if attributes.nil?
       @attributes = attributes
+      @headers = _downcase_keys(headers).slice("link") if headers
     end
 
     def id
-      @attributes['ID']
+      attributes['ID']
     end
 
     protected
@@ -19,22 +22,22 @@ module WP::API
       determinant = key[-1]
       case determinant
       when '?' # example: post.sticky?
-        @attributes[key.chomp(determinant)] == true
+        attributes[key.chomp(determinant)] == true
       when '!' # unsupported
         fail NoMethodError.new(key)
       when '=' # example: post.title = 'my new title'
-        @attributes[key.chomp(determinant)] = new_value
+        attributes[key.chomp(determinant)] = new_value
       else
         # All other values. Hashes are converted to objects
         # if a resource for them exists (e.g. Authors)
-        object key, @attributes[key]
+        object key, attributes[key]
       end
     end
 
     private
 
     def to_s
-      @attributes.to_s
+      attributes.to_s
     end
 
     def object(key, value)
@@ -46,5 +49,13 @@ module WP::API
         value
       end
     end
+
+    def _downcase_keys(hash)
+      Hash.new.tap do |new_hash|
+        hash.each do |k, v|
+          new_hash[k.downcase] = v
+        end
+      end
+    end
   end
 end

data/lib/wp/api/resources/category.rb

@@ -0,0 +1,7 @@
+module WP::API
+  class Category < Resource
+    def to_param
+      slug
+    end
+  end
+end

data/lib/wp/api/resources/post.rb

@@ -1,4 +1,35 @@
 module WP::API
   class Post < Resource
+    def categories
+      terms['category'].collect {|cat| WP::API::Category.new(cat) }
+    end
+
+    def prev
+      item = link_header_items.find {|rel, url| rel == "prev" }
+      item.last if item
+    end
+
+    def next
+      item = link_header_items.find {|rel, url| rel == "next" }
+      item.last if item
+    end
+
+    def items
+      items = link_header_items.select {|rel, url| rel == "item" }
+      items.empty? ? [] : items.collect(&:last)
+    end
+
+    private
+
+    def link_header_items
+      @link_header_items ||= headers['link'].split(', ').collect do |header|
+        [
+          header.match(/rel="([^"]+)"/)[1],
+          header.match(/<([^>]+)>/)[1]
+        ]
+      end
+    rescue
+      []
+    end
   end
 end

data/lib/wp/api/version.rb

@@ -1,5 +1,5 @@
 module WP
   module API
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/wp/api.rb

@@ -1,10 +1,10 @@
 require 'wp/api/version'
+require 'wp/api/errors'
 require 'wp/api/resource'
-Dir['lib/wp/api/resources/*.rb'].each {|resource| require resource }
+Dir[File.expand_path(File.dirname(__FILE__) + '/api/resources/*.rb')].each {|resource| require resource }
 require 'wp/api/client'
 
 require 'httparty'
-require 'yajl'
 
 module WP
   module API

data/spec/endpoints/post_spec.rb

@@ -17,6 +17,14 @@ describe WP::API do
       expect(subject).to be_a WP::API::Post
     end
 
+    it "should have an attributes hash" do
+      expect(subject.attributes).to be_a Hash
+    end
+
+    it "should have a headers hash" do
+      expect(subject.headers).to be_a Hash
+    end
+
     it "should have correct IDs" do
       expect(subject.id).to eq 1
     end

data/spec/endpoints/posts_spec.rb

@@ -1,5 +1,3 @@
-require 'pry'
-
 describe WP::API do
   context "raw HTTP request" do
     let(:response) { HTTParty.get('http://wp.example.com/wp-json/posts').body }
@@ -54,6 +52,24 @@ describe WP::API do
           expect(meta).to be_a Hash
         end
       end
+
+      context "categories" do
+        let(:categories) { subject.categories }
+
+        it "should be converted to a class" do
+          expect(categories.first).to be_a WP::API::Category
+        end
+
+        it "should respond to #to_param" do
+          expect(categories.first.to_param).to eq "foxes"
+        end
+      end
+
+      context "link headers" do
+        its(:next) { should == "/wp-json/posts?page=2" }
+        its(:prev) { should be_nil }
+        its('items.size') { should eq 2 }
+      end
     end
 
   end

data/spec/files/posts/1.json

@@ -165,6 +165,21 @@
           "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms\/1"
         }
       }
+    }],
+    "category": [{
+      "ID": 3,
+      "name": "Foxes",
+      "slug": "foxes",
+      "description": "",
+      "parent": null,
+      "count": 1,
+      "link": "http:\/\/wp.example.com\/category\/foxes\/",
+      "meta": {
+        "links": {
+          "collection": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms",
+          "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms\/3"
+        }
+      }
     }]
   }
-}
+}

data/spec/files/posts/2.json

@@ -165,6 +165,21 @@
           "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms\/2"
         }
       }
+    }],
+    "category": [{
+      "ID": 4,
+      "name": "Cars",
+      "slug": "cars",
+      "description": "",
+      "parent": null,
+      "count": 1,
+      "link": "http:\/\/wp.example.com\/category\/cars\/",
+      "meta": {
+        "links": {
+          "collection": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms",
+          "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms\/4"
+        }
+      }
     }]
   }
-}
+}

data/spec/files/posts.header.txt

@@ -0,0 +1 @@
+</wp-json/posts?page=2>; rel="next", <http://wp.twigtale.com/wp-json/posts/1>; rel="item"; title="First post", <http://wp.twigtale.com/wp-json/posts/2>; rel="item"; title="Second post"

data/spec/files/posts.json

@@ -165,6 +165,21 @@
           "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms\/1"
         }
       }
+    }],
+    "category": [{
+      "ID": 3,
+      "name": "Foxes",
+      "slug": "foxes",
+      "description": "",
+      "parent": null,
+      "count": 1,
+      "link": "http:\/\/wp.example.com\/category\/foxes\/",
+      "meta": {
+        "links": {
+          "collection": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms",
+          "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms\/3"
+        }
+      }
     }]
   }
 },
@@ -335,6 +350,21 @@
           "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/post_tag\/terms\/2"
         }
       }
+    }],
+    "category": [{
+      "ID": 4,
+      "name": "Cars",
+      "slug": "cars",
+      "description": "",
+      "parent": null,
+      "count": 1,
+      "link": "http:\/\/wp.example.com\/category\/cars\/",
+      "meta": {
+        "links": {
+          "collection": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms",
+          "self": "http:\/\/wp.example.com\/wp-json\/taxonomies\/category\/terms\/4"
+        }
+      }
     }]
   }
-}]
+}]

data/spec/helpers/json_helper.rb

@@ -1,3 +1,5 @@
+require 'yajl'
+
 module JSONHelper
   def parse_json(file_or_string)
     Yajl::Parser.new.parse(file_or_string)

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require 'rspec/its'
 Bundler.setup
 
 $LOAD_PATH << File.dirname(__FILE__) + "/../"

data/spec/support/mock_wordpress_server.rb

@@ -14,8 +14,8 @@ class MockWordpressServer
   protected
 
   def register_all
-    FakeWeb.register_uri(:get, "http://#{host}/wp-json/posts", :body => support_file("posts.json"))
-    FakeWeb.register_uri(:get, "http://#{host}/wp-json/posts/1", :body => support_file("posts/1.json"))
-    FakeWeb.register_uri(:get, "http://#{host}/wp-json/posts/2", :body => support_file("posts/2.json"))
+    FakeWeb.register_uri(:get, "http://#{host}/wp-json/posts", :body => support_file("posts.json"), :content_type => "application/json", :link => support_file("posts.header.txt"))
+    FakeWeb.register_uri(:get, "http://#{host}/wp-json/posts/1", :body => support_file("posts/1.json"), :content_type => "application/json")
+    FakeWeb.register_uri(:get, "http://#{host}/wp-json/posts/2", :body => support_file("posts/2.json"), :content_type => "application/json")
   end
 end

data/wp-api.gemspec

@@ -18,14 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'httparty', '~> 0.13.1'
-  spec.add_dependency 'yajl-ruby', '~> 1.2.1'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'addressable'
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'addressable'
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
-  spec.add_development_dependency "fakeweb", "~> 1.3.0"
+  spec.add_development_dependency "yajl-ruby", '~> 1.2.1'
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_development_dependency "rspec", '>= 2.0'
+  spec.add_development_dependency "rspec-its", '>= 1.0.1'
+  spec.add_development_dependency "fakeweb", '~> 1.3', '>= 1.3.0'
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wp-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Colin Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.1
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -80,39 +66,70 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !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: 3.1.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
@@ -120,6 +137,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
@@ -146,19 +166,24 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - lib/wp/api.rb
 - lib/wp/api/client.rb
 - lib/wp/api/endpoints.rb
+- lib/wp/api/errors.rb
 - lib/wp/api/resource.rb
 - lib/wp/api/resources/author.rb
+- lib/wp/api/resources/category.rb
 - lib/wp/api/resources/post.rb
 - lib/wp/api/version.rb
 - spec/endpoints/post_spec.rb
 - spec/endpoints/posts_spec.rb
+- spec/files/posts.header.txt
 - spec/files/posts.json
 - spec/files/posts/1.json
 - spec/files/posts/2.json
@@ -195,6 +220,7 @@ summary: Easily access Wordpress blogs that have the new, RESTful WP API plugin
 test_files:
 - spec/endpoints/post_spec.rb
 - spec/endpoints/posts_spec.rb
+- spec/files/posts.header.txt
 - spec/files/posts.json
 - spec/files/posts/1.json
 - spec/files/posts/2.json