voog_api 0.0.7 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e20e5667103808724ed2df2060430cb06585194
-  data.tar.gz: 87276171f2c2ad169c6241aac2a53e9d3e35a00c
+  metadata.gz: f7f44b299ce7547c3f02afb6ef7c359dc1bb227f
+  data.tar.gz: a11ac4014716a5123f0402e32dc7dbd43b468a47
 SHA512:
-  metadata.gz: 85efc4a527b459c8787b6639dafc1552ea640ed3af02fc2e4568f28b729d0607e4e4ba3ab4e1877251853f3ff6af40354abb31b5e817d18cf37499a14d9fde6a
-  data.tar.gz: d0cf82aad10c84fcf89cd169a01e78263242adb8588771faaef74f3be4e449b9a78d96fd6895b317016a58964e109bf7af251c9b1b02f8de5ee2a69f6ab1f325
+  metadata.gz: c2a7313731a067a53d33b31c39c5d0940dc53d6a150781562850ac46a2e08a937d2c2324e5fe048e46f51dfc1b4410753ecebc5167da3400463686b018d9f0fb
+  data.tar.gz: 31553dcd752fad8a075132e403a50e6df4552b4ca8f2ddc3547ce33688e569b81c67baaf4a9f9a6241507a8972ae00f55d8774e9c6b4b06bfca6fa205edc7624

data/README.markdown

@@ -1,5 +1,7 @@
 # voog.rb
 
+[ ![Codeship Status for Edicy/voog.rb](https://www.codeship.io/projects/785ef4c0-0388-0132-4cf0-0e105ab6f59d/status)](https://www.codeship.io/projects/30460)
+
 Ruby toolkit for the [Voog](http://www.voog.com) API.
 
 Learn more at the [Voog developer central](http://www.voog.com/developers/api) and by reading the [Voog API documentation](http://www.voog.com/developers/api).
@@ -33,7 +35,7 @@ To generate your personal **API token** for your site, go to `Account` -> `My pr
 All requests to the Voog API are done through the `Voog::Client` class, which takes two parameters: site host and API token.
 
 ```ruby
-client = Voog::Client.new('example.com', 'afcf30182aecfc8155d390d7d4552d14')
+client = Voog::Client.new('example.com', 'afcf30182aecfc8155d390d7d4552d14', protocol: :http, auto_paginate: true, raise_on_error: false)
 ```
 
 Making an API request is as simple as calling a single method on the client:
@@ -53,3 +55,10 @@ puts layout.title
 puts layout[:title]
 # => "Front page"
 ```
+
+### Optional parameters for client
+
+* `protocol` - endpoint protocol (`http` or `https` default is `http`).
+* `auto_paginate` - enable auto pagination for list requests. Defaults to `false`.
+* `per_page` - set default `per_page` value for list requests. Defaults to `nil` (API default is `50`).
+* `raise_on_error` - interrupts program with error (`Faraday::Error`) when request response code is between `400` and `600` (default is `false`).

data/Rakefile

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

data/lib/voog_api/api/articles.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List articles
       def articles(params = {})
-        get 'articles', {query: params}
+        paginate 'articles', {query: params}
       end
 
       # Get a single article
@@ -34,14 +34,14 @@ module Voog
 
       # Update/create a key in article data field
       #
-      # @params id [String] key in data field
+      # @param id [String] key in data field
       def update_article_data(article_id, id, data)
         put "articles/#{article_id}/data/#{id}", {value: data}
       end
 
       # Delete a key from article data field
       #
-      # @params id [String] key in data field
+      # @param id [String] key in data field
       def delete_article_data(article_id, id)
         delete "articles/#{article_id}/data/#{id}"
       end

data/lib/voog_api/api/assets.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List assets
       def assets(params = {})
-        get 'assets', {query: params}
+        paginate 'assets', {query: params}
       end
 
       # Get a single asset

data/lib/voog_api/api/comments.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List article comments
       def comments(article_id, params = {})
-        get "articles/#{article_id}/comments", {query: params}
+        paginate "articles/#{article_id}/comments", {query: params}
       end
 
       # Get a single comment for article

data/lib/voog_api/api/content_partials.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List content partials contents
       def content_partials(params = {})
-        get 'content_partials', {query: params}
+        paginate 'content_partials', {query: params}
       end
 
       # Get a single content partial content

data/lib/voog_api/api/contents.rb

@@ -11,7 +11,7 @@ module Voog
 
       # List contents
       def contents(parent_name, parent_id, params = {})
-        get "#{parent_name}/#{parent_id}/contents", {query: params}
+        paginate "#{parent_name}/#{parent_id}/contents", {query: params}
       end
 
       # Get a single content

data/lib/voog_api/api/element_definitions.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List element_definitions
       def element_definitions(params = {})
-        get 'element_definitions', {query: params}
+        paginate 'element_definitions', {query: params}
       end
 
       # Get a single element_definition

data/lib/voog_api/api/elements.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List elements
       def elements(params = {})
-        get 'elements', {query: params}
+        paginate 'elements', {query: params}
       end
 
       # Get a single element

data/lib/voog_api/api/forms.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List forms
       def forms(params = {})
-        get 'forms', {query: params}
+        paginate 'forms', {query: params}
       end
 
       # Get a single form

data/lib/voog_api/api/languages.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List languages
       def languages(params = {})
-        get 'languages', {query: params}
+        paginate 'languages', {query: params}
       end
 
       # Get a single language

data/lib/voog_api/api/layout_assets.rb

@@ -4,7 +4,7 @@ module Voog
       
       # List layouts assets
       def layout_assets(params = {})
-        get 'layout_assets', {query: params}
+        paginate 'layout_assets', {query: params}
       end
 
       # Get a single layout asset
@@ -15,6 +15,7 @@ module Voog
       # Create a layout asset
       def create_layout_asset(data)
         if data && data.key?(:file)
+          data = data.dup
           data[:file] = Faraday::UploadIO.new(data[:file], data[:content_type])
           options = {multipart: true}
         end

data/lib/voog_api/api/layouts.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List layouts
       def layouts(params = {})
-        get 'layouts', {query: params}
+        paginate 'layouts', {query: params}
       end
 
       # Get a single layout

data/lib/voog_api/api/media_sets.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List media_sets
       def media_sets(params = {})
-        get 'media_sets', {query: params}
+        paginate 'media_sets', {query: params}
       end
 
       # Get a single media_set
@@ -29,7 +29,7 @@ module Voog
 
       # Add assets to media_set
       def media_set_add_assets(media_set_id, data)
-        put "media_sets/#{media_set_id}/add_assets", data
+        post "media_sets/#{media_set_id}/add_assets", data
       end
     end
   end

data/lib/voog_api/api/nodes.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List nodes
       def nodes(params = {})
-        get 'nodes', {query: params}
+        paginate 'nodes', {query: params}
       end
 
       # Get a single node

data/lib/voog_api/api/pages.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List pages
       def pages(params = {})
-        get 'pages', {query: params}
+        paginate 'pages', {query: params}
       end
 
       # Get a single page
@@ -34,14 +34,14 @@ module Voog
 
       # Update/create a key in page data field
       #
-      # @params id [String] key in data field
+      # @param id [String] key in data field
       def update_page_data(page_id, id, data)
         put "pages/#{page_id}/data/#{id}", {value: data}
       end
 
       # Delete a key from page data field
       #
-      # @params id [String] key in data field
+      # @param id [String] key in data field
       def delete_page_data(page_id, id)
         delete "pages/#{page_id}/data/#{id}"
       end

data/lib/voog_api/api/people.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List people
       def people(params = {})
-        get 'people', {query: params}
+        paginate 'people', {query: params}
       end
 
       # Get a single person

data/lib/voog_api/api/site.rb

@@ -19,14 +19,14 @@ module Voog
 
       # Update/create a key in site data field
       #
-      # @params id [String] key in data field
+      # @param id [String] key in data field
       def update_site_data(id, data)
         put "site/data/#{id}", {value: data}
       end
 
       # Delete a key from site data field
       #
-      # @params id [String] key in data field
+      # @param id [String] key in data field
       def delete_site_data(id)
         delete "site/data/#{id}"
       end

data/lib/voog_api/api/tags.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List tags
       def tags(params = {})
-        get 'tags', {query: params}
+        paginate 'tags', {query: params}
       end
 
       # Get a single tag

data/lib/voog_api/api/texts.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List text contents
       def texts(params = {})
-        get 'texts', {query: params}
+        paginate 'texts', {query: params}
       end
 
       # Get a single text content

data/lib/voog_api/api/tickets.rb

@@ -4,7 +4,7 @@ module Voog
 
       # List form tickets
       def tickets(form_id, params = {})
-        get "forms/#{form_id}/tickets", {query: params}
+        paginate "forms/#{form_id}/tickets", {query: params}
       end
 
       # Get a single ticket for form

data/lib/voog_api/client.rb

@@ -1,6 +1,8 @@
 require 'json'
 require 'sawyer'
 
+require 'voog_api/error'
+
 require 'voog_api/api/articles'
 require 'voog_api/api/assets'
 require 'voog_api/api/comments'
@@ -24,7 +26,9 @@ require 'voog_api/api/tickets'
 module Voog
   
   class Client
-    
+
+    MAX_PER_PAGE = 250
+
     include Voog::API::Articles
     include Voog::API::Assets
     include Voog::API::Comments
@@ -45,12 +49,25 @@ module Voog
     include Voog::API::Texts
     include Voog::API::Tickets
 
-    attr_reader :api_token, :host
+    attr_reader :api_token, :host, :auto_paginate, :per_page
 
+    # Initialize Voog API client.
+    #
+    # @param host [String] a Voog site host.
+    # @param api_token [String] a Voog site API token.
+    # @option options [String] :protocol endpoint protocol ("http" or "https"). Defaults to "http".
+    # @option options [String] :auto_paginate enable auto pagination for list requests. Defaults to "false".
+    # @option options [String] :per_page set default "per_page" value for list requests. Defaults to "nil".
+    # @option options [Boolean] :raise_on_error interrupts program with error ("Faraday::Error") when request response code is between "400" and "600" (default is "false").
+    # @example Initialize client
+    #   client = Voog::Client.new('example.com', 'afcf30182aecfc8155d390d7d4552d14', protocol: :http, raise_on_error: false)
     def initialize(host = Voog.host, api_token = Voog.api_token, options = {})
       @host = host
       @api_token = api_token
       @options = options
+      @protocol = options[:protocol].to_s.downcase == 'https' ? 'https' : 'http'
+      @auto_paginate = options.fetch(:auto_paginate, Voog.auto_paginate)
+      @per_page = options.fetch(:per_page, Voog.per_page)
       @raise_on_error = options.fetch(:raise_on_error, true)
     end
 
@@ -79,7 +96,7 @@ module Voog
     end
     
     def api_endpoint
-      "http://#{host}/admin/api"
+      "#{@protocol}://#{host}/admin/api"
     end
     
     def agent
@@ -92,13 +109,13 @@ module Voog
     end
 
     def multipart_agent
-      Faraday.new do |faraday|
+      @multipart_agent ||= Faraday.new do |faraday|
         faraday.request :multipart
         faraday.response :raise_error if @raise_on_error
         faraday.adapter :net_http
 
-        faraday.headers['X_API_TOKEN'] = @api_token
-        faraday.headers['User-Agent'] = 'Voog.rb Ruby wrapper'
+        faraday.headers[:x_api_token] = @api_token
+        faraday.headers[:user_agent] = 'Voog.rb Ruby wrapper'
       end
     end
     
@@ -109,7 +126,32 @@ module Voog
     def parse_response(response)
       JSON.parse(response).inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
     end
-    
+
+    # Fetch all elements for requested API resource when {#auto_paginate} is turned on.
+    def paginate(url, options = {}, &block)
+      opts = options.dup
+      if @auto_paginate || @per_page
+        opts[:query][:per_page] ||= @per_page || (@auto_paginate ? MAX_PER_PAGE : nil)
+      end
+
+      data = request(:get, url, nil, opts)
+
+      if @auto_paginate
+        i = 0
+        while @last_response.rels[:next]
+          puts "Request: #{i += 1}"
+          @last_response = @last_response.rels[:next].get(headers: opts[:headers])
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+          end
+        end
+      end
+
+      data
+     end
+
     private
     
     def request(method, path, data, options = {})
@@ -117,7 +159,10 @@ module Voog
 
       @last_response = response = multipart ? \
         multipart_agent.post("#{api_endpoint}/#{path}", data) : \
-        agent.call(method, URI.encode(path.to_s), data, options)
+        agent.call(method, URI.encode(path.to_s), data, options.dup)
+
+      raise Voog::MovedPermanently.new(response.headers['location']) if response.status == 301
+
       if multipart
         parse_response(response.body)
       else

data/lib/voog_api/error.rb

@@ -0,0 +1,6 @@
+module Voog
+
+  # Raised when Voog API returns a 301 HTTP status code
+  class MovedPermanently < StandardError; end
+
+end

data/lib/voog_api/version.rb

@@ -1,3 +1,3 @@
 module Voog
-  VERSION = '0.0.7'
+  VERSION = '0.0.10'
 end

data/lib/voog_api.rb

@@ -5,7 +5,7 @@ module Voog
 
   class << self
     
-    attr_accessor :host, :api_token
+    attr_accessor :host, :api_token, :auto_paginate, :per_page
 
     def client(options = {})
       unless host.nil? && api_token.nil?

data/spec/voog_api/api/media_sets_spec.rb

@@ -54,7 +54,7 @@ describe Voog::API::MediaSets do
   describe '#media_set_add_assets' do
 
     before do
-      request_fixture(:put, 'media_sets/2/add_assets', request: {body: {asset_ids: [5, 8]}}, response: {body: '{"id": 2, "assets": [{"id": 1}, {"id": 5}, {"id": 8}]}'})
+      request_fixture(:post, 'media_sets/2/add_assets', request: {body: {asset_ids: [5, 8]}}, response: {body: '{"id": 2, "assets": [{"id": 1}, {"id": 5}, {"id": 8}]}'})
     end
 
     it 'responds with correct assets set' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voog_api
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.10
 platform: ruby
 authors:
 - Priit Haamer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,7 @@ files:
 - lib/voog_api/api/texts.rb
 - lib/voog_api/api/tickets.rb
 - lib/voog_api/client.rb
+- lib/voog_api/error.rb
 - lib/voog_api/version.rb
 - spec/fixtures/articles/article.json
 - spec/fixtures/articles/articles.json
@@ -276,3 +277,4 @@ test_files:
 - spec/voog_api/api/texts_spec.rb
 - spec/voog_api/api/tickets_spec.rb
 - spec/voog_spec.rb
+has_rdoc: