wp-api-client 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c50b50f037a644caac4f4b7a62151dc611b97744
-  data.tar.gz: 6c5bad2367af9c5965f5d2ccd7aeccd06b24bb08
+  metadata.gz: 3c79a386294cc7fb4cba0a13895836546f44d6bd
+  data.tar.gz: 95f7761c08ea70c9d00d7a93f5581cc1428f2393
 SHA512:
-  metadata.gz: 1d095bc06ef8e4d2a3575c321ba965f6e55ef05526b2d6a4f1133bd9576eccdf0ca5838a5fa7a6a608cb946a8e8190c28c5bbebeb888a3f514f0cf37b3ae67d3
-  data.tar.gz: ea828e89a0b046c617fae2a6ec55639326a0ed579dd63853210c5af8482e6d6b7e273bd806eed244e784746d3682584c90a0cd837e575edac7f39e59dce0dd99
+  metadata.gz: ee69105e832eb279cf28c6b8d29ecb38a83e5ceb3d086b8b56297bf62285f6087f85dfa91d62c26d99bf601b5e07b98edf153de79023f7ff3d5cece72097cb5d
+  data.tar.gz: 48bc17fffdde6b9a2f7badf75d4864ea2809646451a35f4f55abc99b6f9e808eb8eb954e117dd3f2cb0d73e93c10c8ae89007234d3baf169b389d8758b4d4a96

data/README.md

@@ -4,6 +4,8 @@ This unambitious client provides read-only access for WP-API v2.
 
 It supports authentication via OAuth or Basic Auth.
 
+It can make concurrent requests.
+
 It does not support comments, users or POST requests.
 
 It requires **Ruby 2.3** and is tested against **WP-API 2.0-beta12**.
@@ -72,7 +74,7 @@ posts.total_available
 next_page = @api.get(posts.next_page)
 # => #<WpApiClient::Collection:0x00bbcafe938827 @resources=[#<WpApiClient::Entities::Post...
 
-page_after_that = @api.get(next_page.page_after_that)
+page_after_that = @api.get(next_page.next_page)
 # => #<WpApiClient::Collection:0x00bbcafe938827 @resources=[#<WpApiClient::Entities::Post...
 ```
 
@@ -158,6 +160,23 @@ end
 client = WpApiClient.get_client
 ```
 
+## Concurrency
+
+WP-API is _slow_: a typical request takes 0.5s. To mitigate this, I recommend
+caching all your responses sensibly, and when you need to fetch, do so concurrently
+as far as is possible.
+
+```ruby
+results = []
+client.concurrently do |api|
+  results << api.get('post/1')
+  results << api.get('post/2')
+  results << api.get('post/3')
+end
+results
+# => [#<WpApiClient::Entities::Post>, #<WpApiClient::Entities::Post, #<WpApiClient::Entities::Post>]
+```
+
 ## Testing and compatibility
 
 This library comes with VCR cassettes recorded against a local WP installation

data/lib/wp_api_client.rb

@@ -11,6 +11,7 @@ require "wp_api_client/entities/image"
 require "wp_api_client/entities/types"
 
 require "wp_api_client/client"
+require "wp_api_client/concurrent_client"
 require "wp_api_client/connection"
 require "wp_api_client/collection"
 require "wp_api_client/relationship"

data/lib/wp_api_client/client.rb

@@ -6,10 +6,21 @@ module WpApiClient
     end
 
     def get(url, params = {})
-      response = @connection.get(api_path_from(url), params)
-      @headers = response.headers
+      if @concurrent_client
+        @concurrent_client.get(api_path_from(url), params)
+      else
+        response = @connection.get(api_path_from(url), params)
+        @headers = response.headers
+        native_representation_of response.body
+      end
+    end
 
-      native_representation_of response.body
+    def concurrently
+      @concurrent_client ||= ConcurrentClient.new(@connection)
+      yield @concurrent_client
+      result = @concurrent_client.run
+      @concurrent_client = nil
+      result
     end
 
   private

data/lib/wp_api_client/collection.rb

@@ -24,7 +24,7 @@ module WpApiClient
     def previous_page
       @links[:prev] && @links[:prev]
     end
-
+    
 private
 
     # https://www.snip2code.com/Snippet/71914/Parse-link-headers-from-Github-API-in-Ru

data/lib/wp_api_client/concurrent_client.rb

@@ -0,0 +1,15 @@
+module WpApiClient
+  class ConcurrentClient < Client
+
+    def get(url, params = {})
+      @queue ||= []
+      @queue << [api_path_from(url), params]
+    end
+
+    def run
+      responses = @connection.get_concurrently(@queue)
+      responses.map { |r| native_representation_of(r.body) }
+    end
+
+  end
+end

data/lib/wp_api_client/connection.rb

@@ -1,14 +1,18 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday-http-cache'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
 
 module WpApiClient
   class Connection
 
     attr_accessor :headers
+    attr_reader :concurrent
 
     def initialize(configuration)
       @configuration = configuration
+      @queue = []
       @conn = Faraday.new(url: configuration.endpoint) do |faraday|
 
         if configuration.oauth_credentials
@@ -21,21 +25,47 @@ module WpApiClient
 
         if configuration.debug
           faraday.response :logger
+          faraday.use :instrumentation
         end
 
         if configuration.cache
-          faraday.use :http_cache, store: configuration.cache
+          faraday.use :http_cache, store: configuration.cache, shared_cache: false
         end
 
         faraday.use Faraday::Response::RaiseError
         faraday.response :json, :content_type => /\bjson$/
-        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.adapter  :typhoeus
       end
     end
 
     # translate requests into wp-api urls
     def get(url, params = {})
-      @conn.get url, params.merge(@configuration.request_params)
+      @conn.get url, parse_params(params)
     end
+
+    # requests come in as url/params pairs
+    def get_concurrently(requests)
+      responses = []
+      @conn.in_parallel do
+        requests.map do |r|
+          responses << get(r[0], r[1])
+        end
+      end
+      responses
+    end
+
+private
+
+    def parse_params(params)
+      params = @configuration.request_params.merge(params)
+      # if _embed is present at all it will have the effect of embedding —
+      # even if it's set to "false"
+      if params[:_embed] == false
+        params.delete(:_embed)
+      end
+      params
+    end
+
+
   end
 end

data/lib/wp_api_client/relationship.rb

@@ -101,7 +101,14 @@ Available mappings are :post, :term, and :meta.}
         unless position.nil?
           location = @resource["_links"].dig(relationship, position.to_i, "href")
         else
-          location = @resource["_links"][relationship]["href"]
+          if @resource["_links"][relationship].is_a? Array
+            # If the resources are linked severally, crank through and
+            # retrieve them one by one as an array
+            return @resource["_links"][relationship].map { |link| WpApiClient.get_client.get(link["href"]) }
+          else
+            # Otherwise, get the single link to the lot
+            location = @resource["_links"][relationship]["href"]
+          end
         end
         WpApiClient.get_client.get(location) if location
       end

data/lib/wp_api_client/version.rb

@@ -1,3 +1,3 @@
 module WpApiClient
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/wp_api_client.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware", "~> 0.10"
   spec.add_dependency "faraday-http-cache", "~> 1.2"
   spec.add_dependency "simple_oauth", "~> 0.3"
+  spec.add_dependency "typhoeus", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wp-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Duncan Brown
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,7 @@ files:
 - lib/wp_api_client.rb
 - lib/wp_api_client/client.rb
 - lib/wp_api_client/collection.rb
+- lib/wp_api_client/concurrent_client.rb
 - lib/wp_api_client/configuration.rb
 - lib/wp_api_client/connection.rb
 - lib/wp_api_client/entities/base.rb