wp-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1e0339d85de70f76fa1053b11e8c81d34498b57
+  data.tar.gz: 96321f28e3713c144ee3d580e364ead14a530268
+SHA512:
+  metadata.gz: 0852242e985bd4de60df6820b522845f422f608e1db5efe3e0e40f429ec5353bbdd6310d0050d9a18edb7aef05c91a6ec2d127b76b29d4db2d751a48bed59bff
+  data.tar.gz: f7bc70aa9662df06d7916f647119021113ff04c838ccb0090681618436b2cbf341d850425f18851b5839eea9108cf9e0638c759fb5a60aaec462c004a6cff3fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at duncanjbrown@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Duncan Brown
+
+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,130 @@
+# A read-only Ruby client for WP-API v2
+
+This unambitious client provides read-only access for WP-API v2.
+
+It does not support authentication (yet).
+
+It does not support comments or POST requests.
+
+It requires **Ruby 2.3** and is tested against **WP-API 2.0-beta12**.
+
+## Installation
+
+```ruby
+gem install wp-api-client
+```
+
+And
+
+```ruby
+require 'wp_api_client'
+```
+
+## Usage examples
+
+#### Set up the client and get some posts
+
+```ruby
+# create a client
+@connection = WpApiClient::Connection.new('http://localhost:8080/wp-json/wp/v2')
+@api = WpApiClient::Client.new(@connection)
+
+# get some posts
+posts = @api.get('custom_post_type/') # or "posts/" etc
+# => <WpApiClient::Collection:0x007fed432a5660 @resources=[#<WpApiClient::Entities::Post...
+
+posts.map { |p| puts p.title }
+# Custom Post Type 99
+# Custom Post Type 98
+# Custom Post Type 97
+
+term = @posts.first.terms.first
+# => #<WpApiClient::Entities::Term:0x007fed42b3e458 @resource={"id"=>2...
+```
+
+#### Navigate between posts, terms and taxonomies
+
+```ruby
+term.taxonomy
+# => #<WpApiClient::Entities::Taxonomy:0x007f9c2c86f1a8 @resource={"name"=>"Custom taxonomy"...
+
+term.posts
+# => #<WpApiClient::Collection:0x007fd65d07d588 @resources=[#<WpApiClient::Entities::Post...
+
+# term.posts.first.terms.first.taxonomy.terms.first... etc etc etc
+```
+
+#### Pagination
+
+```ruby
+posts = @api.get('posts', page: 2)
+
+posts.count
+# => 10
+
+posts.total_available
+# => 100
+
+next_page = @api.get(posts.next_page)
+# => #<WpApiClient::Collection:0x00bbcafe938827 @resources=[#<WpApiClient::Entities::Post...
+
+page_after_that = @api.get(next_page.page_after_that)
+# => #<WpApiClient::Collection:0x00bbcafe938827 @resources=[#<WpApiClient::Entities::Post...
+```
+
+#### Loading a taxonomy via a slug
+
+WP-API returns an array even if there's only one result, so you need to be careful here
+
+```ruby
+term = @api.get('custom_taxonomy', slug: 'term_one').first
+taxonomy_name = term.taxonomy.name
+posts = term.posts
+```
+
+## Testing and compatibility
+
+This library comes with VCR cassettes recorded against a local WP installation
+running WP-API v2-beta12. It is not tested with other versions.
+
+To run the tests, invoke `rspec`.
+
+## Structure
+
+### Public Objects
+
+#### `WpApiClient::Client`
+
+Accepts a `WpApiClient::Connection` and exposes a `#get` method.
+
+Pass a URL into `#get` and it will do its best to return usable data.
+
+The second parameter accepts an optional hash of query params.
+
+#### `WpApiClient::Connection`
+
+Initialize with an API endpoint like `http://localhost:8080/wp-json/wp/v2`, then
+pass into a new client. Faraday options might be pulled out of here in the future.
+
+### Internal Objects
+
+#### `WpApiClient::Collection`
+
+Wraps a set of `WpApiClient::Entities` in an `Enumerable` interface and provides `next_page`
+and `previous_page` methods. Pass these into `@api` and it will give you back the
+data you want
+
+```ruby
+next_page = @api.get(posts.next_page)
+# => #<WpApiClient::Collection:0x00bbcafe938827 @resources=[#<WpApiClient::Entities::Post...
+```
+
+#### `WpApiClient::Entities::BaseEntity`
+
+Base class for `Post`, `Term` and `Taxonomy`, so far. Not all methods are implemented.
+
+## Other
+
+This library puts `?_embed` on every request to save on HTTP requests right now.
+
+Thanks [WP-API](https://github.com/WP-API/WP-API)!

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wp_api_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wp_api_client.rb

@@ -0,0 +1,10 @@
+require "wp_api_client/version"
+
+require "wp_api_client/entities/base_entity"
+require "wp_api_client/entities/post"
+require "wp_api_client/entities/taxonomy"
+require "wp_api_client/entities/term"
+
+require "wp_api_client/client"
+require "wp_api_client/connection"
+require "wp_api_client/collection"

data/lib/wp_api_client/client.rb

@@ -0,0 +1,47 @@
+module WpApiClient
+  class Client
+
+    Types = [
+      WpApiClient::Entities::Post,
+      WpApiClient::Entities::Term,
+      WpApiClient::Entities::Taxonomy
+    ]
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get(url, params = {})
+      response = @connection.get(api_path_from(url), params)
+      @headers = response.headers
+
+      native_representation_of response.body
+    end
+
+  private
+
+    def api_path_from(url)
+      url.split('wp/v2/').last
+    end
+
+    # Take the API response and figure out what it is
+    def native_representation_of(response_body)
+      if response_body.is_a? Array
+        collection = true
+        object = response_body.first
+      else
+        collection = false
+        object = response_body
+      end
+
+      type = Types.find { |type| type.represents?(object) }
+
+      if collection
+        resources = response_body.map! { |object| type.new(object, self) }
+        WpApiClient::Collection.new(resources, @headers)
+      else
+        type.new(response_body, self)
+      end
+    end
+  end
+end

data/lib/wp_api_client/collection.rb

@@ -0,0 +1,45 @@
+module WpApiClient
+  class Collection
+    include Enumerable
+
+    attr_accessor :resources, :total_available
+
+    def initialize(resources, headers)
+      @resources = resources
+      @links = parse_link_header(headers['Link'])
+      @total_available = headers['X-WP-TOTAL'].to_i
+    end
+
+    def each(&block)
+      @resources.each{|p| block.call(p)}
+    end
+
+    def next_page
+      @links[:next] && @links[:next]
+    end
+
+    def previous_page
+      @links[:prev] && @links[:prev]
+    end
+
+    def method_missing(sym)
+      @resources.send(sym)
+    end
+
+private
+
+    # https://www.snip2code.com/Snippet/71914/Parse-link-headers-from-Github-API-in-Ru
+    def parse_link_header(header, params={})
+      links = Hash.new
+      return links unless header
+      parts = header.split(',')
+      parts.each do |part, index|
+        section = part.split(';')
+        url = section[0][/<(.*)>/,1]
+        name = section[1][/rel="(.*)"/,1].to_sym
+        links[name] = url
+      end
+      return links
+    end
+  end
+end

data/lib/wp_api_client/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module WpApiClient
+  class Connection
+
+    attr_accessor :headers
+
+    def initialize(endpoint)
+      @conn = Faraday.new(:url => endpoint) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        #faraday.response :logger                  # log requests to STDOUT
+        faraday.response :json, :content_type => /\bjson$/
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    # translate requests into wp-api urls
+    def get(url, params = {})
+      @conn.get url, params.merge({_embed: true})
+    end
+  end
+end

data/lib/wp_api_client/entities/base_entity.rb

@@ -0,0 +1,25 @@
+module WpApiClient
+  module Entities
+    class BaseEntity
+      attr_reader :resource
+
+      def initialize(resource, api)
+        unless resource.is_a? Hash
+          raise ArgumentError.new('Tried to initialize a WP-API resource with something other than a Hash')
+        end
+        @resource = resource
+        @api = api
+      end
+
+      def links
+        resource["_links"]
+      end
+
+      def embedded
+        resource["_embedded"]
+      end
+
+      alias :embedded? :embedded
+    end
+  end
+end

data/lib/wp_api_client/entities/post.rb

@@ -0,0 +1,39 @@
+module WpApiClient
+  module Entities
+    class Post < BaseEntity
+      alias :post :resource
+
+      def self.represents?(json)
+        json.dig("_links", "about") and json["_links"]["about"].first["href"] =~ /wp\/v2\/types/
+      end
+
+      def title
+        post["title"]["rendered"]
+      end
+
+      def date
+        Time.new(post["date_gmt"])
+      end
+
+      def content
+        post["content"]["rendered"]
+      end
+
+      def id
+        post["id"]
+      end
+
+      def terms
+        if embedded?
+          terms = []
+          embedded["https://api.w.org/term"].map do |taxonomy|
+            taxonomy.each do |term|
+              terms << WpApiClient::Entities::Term.new(term, @api)
+            end
+          end
+          terms
+        end
+      end
+    end
+  end
+end

data/lib/wp_api_client/entities/taxonomy.rb

@@ -0,0 +1,19 @@
+module WpApiClient
+  module Entities
+    class Taxonomy < BaseEntity
+      alias :taxonomy :resource
+
+      def self.represents?(json)
+        !json.dig("hierarchical").nil?
+      end
+
+      def name
+        taxonomy["name"]
+      end
+
+      def terms
+        @api.get(links["https://api.w.org/items"].first["href"])
+      end
+    end
+  end
+end

data/lib/wp_api_client/entities/term.rb

@@ -0,0 +1,34 @@
+module WpApiClient
+  module Entities
+    class Term < BaseEntity
+      alias :term :resource
+
+      def self.represents?(json)
+        json.dig("_links", "about") and json["_links"]["about"].first["href"] =~ /wp\/v2\/taxonomies/
+      end
+
+      def taxonomy
+        @api.get(links["about"].first["href"])
+      end
+
+      def posts(post_type = "post")
+        post_type_links = links["http://api.w.org/v2/post_type"]
+        link = post_type_links.find { |link| link["href"] =~ /wp\/v2\/#{post_type}/ }
+        @api.get(link["href"]) if link
+      end
+
+      def name
+        term["name"]
+      end
+
+      def slug
+        term["slug"]
+      end
+
+      def id
+        term["id"]
+      end
+
+    end
+  end
+end

data/lib/wp_api_client/version.rb

@@ -0,0 +1,3 @@
+module WpApiClient
+  VERSION = "0.1.0"
+end

data/wp_api_client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wp_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wp-api-client"
+  spec.version       = WpApiClient::VERSION
+  spec.authors       = ["Duncan Brown"]
+  spec.email         = ["duncanjbrown@gmail.com"]
+
+  spec.summary       = %q{A read-only client for the WordPress REST API (v2).}
+  spec.homepage      = "https://github.com/duncanjbrown/wp-api-client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.10"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: wp-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Duncan Brown
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- duncanjbrown@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wp_api_client.rb
+- lib/wp_api_client/client.rb
+- lib/wp_api_client/collection.rb
+- lib/wp_api_client/connection.rb
+- lib/wp_api_client/entities/base_entity.rb
+- lib/wp_api_client/entities/post.rb
+- lib/wp_api_client/entities/taxonomy.rb
+- lib/wp_api_client/entities/term.rb
+- lib/wp_api_client/version.rb
+- wp_api_client.gemspec
+homepage: https://github.com/duncanjbrown/wp-api-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A read-only client for the WordPress REST API (v2).
+test_files: []