voog_api 0.0.10 → 0.0.11

data/lib/voog_api/api/media_sets.rb

@@ -1,33 +1,49 @@
 module Voog
   class API
+
+    # Voog Media Sets API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/media_sets
     module MediaSets
 
       # List media_sets
+      #
+      # @see http://www.voog.com/developers/api/resources/media_sets#get_media_sets
       def media_sets(params = {})
         paginate 'media_sets', {query: params}
       end
 
       # Get a single media_set
+      #
+      # @see http://www.voog.com/developers/api/resources/media_sets#get_media_set
       def media_set(id, params = {})
         get "media_sets/#{id}", {query: params}
       end
 
       # Create a media_set
+      #
+      # @see http://www.voog.com/developers/api/resources/media_sets#create_media_set
       def create_media_set(data)
         post 'media_sets', data
       end
 
       # Update a media_set
+      #
+      # @see http://www.voog.com/developers/api/resources/media_sets#update_media_set
       def update_media_set(id, data)
         put "media_sets/#{id}", data
       end
 
       # Delete a media_set
+      #
+      # @see http://www.voog.com/developers/api/resources/media_sets#remove_media_set
       def delete_media_set(id)
         delete "media_sets/#{id}"
       end
 
       # Add assets to media_set
+      #
+      # @see http://www.voog.com/developers/api/resources/media_sets#add_asset_to_media_set
       def media_set_add_assets(media_set_id, data)
         post "media_sets/#{media_set_id}/add_assets", data
       end

data/lib/voog_api/api/nodes.rb

@@ -1,23 +1,35 @@
 module Voog
   class API
+
+    # Voog Nodes API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/nodes
     module Nodes
 
       # List nodes
+      #
+      # @see http://www.voog.com/developers/api/resources/nodes#get_nodes
       def nodes(params = {})
         paginate 'nodes', {query: params}
       end
 
       # Get a single node
+      #
+      # @see http://www.voog.com/developers/api/resources/nodes#get_node
       def node(id, params = {})
         get "nodes/#{id}", {query: params}
       end
 
       # Update a node
+      #
+      # @see http://www.voog.com/developers/api/resources/nodes#update_node
       def update_node(id, data)
         put "nodes/#{id}", data
       end
 
       # Reorder a node
+      #
+      # @see http://www.voog.com/developers/api/resources/nodes#relocate_node
       def move_node(node_id, params)
         put "nodes/#{node_id}/move", nil, {query: params}
       end

data/lib/voog_api/api/pages.rb

@@ -1,33 +1,49 @@
 module Voog
   class API
+
+    # Voog Pages API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/pages
     module Pages
 
       # List pages
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#get_pages
       def pages(params = {})
         paginate 'pages', {query: params}
       end
 
       # Get a single page
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#get_page
       def page(id, params = {})
         get "pages/#{id}", {query: params}
       end
 
       # Create a page
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#create_pages
       def create_page(data)
         post 'pages', data
       end
 
       # Update a page
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#update_page
       def update_page(id, data)
         put "pages/#{id}", data
       end
 
       # Patch a page
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#patch_page
       def patch_page(id, data)
         patch "pages/#{id}", data
       end
 
       # Delete a page
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#delete_page
       def delete_page(id)
         delete "pages/#{id}"
       end
@@ -35,6 +51,8 @@ module Voog
       # Update/create a key in page data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#update_page_data_field
       def update_page_data(page_id, id, data)
         put "pages/#{page_id}/data/#{id}", {value: data}
       end
@@ -42,6 +60,8 @@ module Voog
       # Delete a key from page data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/pages#delete_page_data_field
       def delete_page_data(page_id, id)
         delete "pages/#{page_id}/data/#{id}"
       end
@@ -49,26 +69,36 @@ module Voog
       # Page contents
 
       # List contents for page
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_contents
       def page_contents(id, params = {})
         contents(Voog::API::Contents::ParentKind::Page, id, params)
       end
 
       # Get a single content for page
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_content
       def page_content(page_id, id, params = {})
         content(Voog::API::Contents::ParentKind::Page, page_id, id, params)
       end
 
       # Create a page content for page
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#create_content
       def create_page_content(page_id, data)
         create_content(Voog::API::Contents::ParentKind::Page, page_id, data)
       end
 
       # Delete a content from page
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#delete_content
       def delete_page_content(page_id, id)
         delete_content(Voog::API::Contents::ParentKind::Page, page_id, id)
       end
 
       # Reorder/move page content inside/between content areas and parent objects
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#relocate_content
       def move_page_content(page_id, id, params = {})
         move_content(Voog::API::Contents::ParentKind::Page, page_id, id, params)
       end

data/lib/voog_api/api/people.rb

@@ -1,13 +1,21 @@
 module Voog
   class API
+
+    # Voog People API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/people
     module People
 
       # List people
+      #
+      # @see http://www.voog.com/developers/api/resources/people#get_people
       def people(params = {})
         paginate 'people', {query: params}
       end
 
       # Get a single person
+      #
+      # @see http://www.voog.com/developers/api/resources/people#get_person
       def person(id, params = {})
         get "people/#{id}", {query: params}
       end

data/lib/voog_api/api/search.rb

@@ -0,0 +1,17 @@
+module Voog
+  class API
+
+    # Voog site Search API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/search
+    module Search
+
+      # Perform full text search over current public (and indexed) content.
+      #
+      # @see http://www.voog.com/developers/api/resources/search#get_search
+      def search(params = {})
+        paginate 'search', {query: params}
+      end
+    end
+  end
+end

data/lib/voog_api/api/site.rb

@@ -1,18 +1,28 @@
 module Voog
   class API
+
+    # Voog Site API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/site
     module Site
 
       # Get site attributes
+      #
+      # @see http://www.voog.com/developers/api/resources/site#get_site
       def site(params = {})
         get 'site', {query: params}
       end
 
       # Update a site
+      #
+      # @see http://www.voog.com/developers/api/resources/site#update_sites
       def update_site(data)
         put "site", data
       end
 
       # Patch a site
+      #
+      # @see http://www.voog.com/developers/api/resources/site#patch_sites
       def patch_site(data)
         patch "site", data
       end
@@ -20,6 +30,8 @@ module Voog
       # Update/create a key in site data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/site#update_site_data
       def update_site_data(id, data)
         put "site/data/#{id}", {value: data}
       end
@@ -27,6 +39,8 @@ module Voog
       # Delete a key from site data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/site#delete_site_data_field
       def delete_site_data(id)
         delete "site/data/#{id}"
       end

data/lib/voog_api/api/site_users.rb

@@ -0,0 +1,39 @@
+module Voog
+  class API
+
+    # Voog Site Users API methods. Manage users who have access to password protected pages.
+    #
+    # @see http://www.voog.com/support/guides/managing-your-website-pages/password-protected-pages
+    # @see http://www.voog.com/developers/api/resources/site_users
+    module SiteUsers
+
+      # List site users with access to password protected pages
+      #
+      # @see http://www.voog.com/developers/api/resources/site_users#get_site_users
+      def site_users(params = {})
+        paginate 'site_users', {query: params}
+      end
+
+      # Invite a new user to see password protected pages
+      #
+      # @see http://www.voog.com/developers/api/resources/site_users#create_site_user
+      def create_site_user(data)
+        post 'site_users', data
+      end
+      
+      # Get a single site user
+      #
+      # @see http://www.voog.com/developers/api/resources/site_users#get_site_user
+      def site_user(id, params = {})
+        get "site_users/#{id}", {query: params}
+      end
+
+      # Delete a site user
+      #
+      # @see http://www.voog.com/developers/api/resources/site_users#remove_site_user
+      def delete_site_user(id)
+        delete "site_users/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/tags.rb

@@ -1,23 +1,35 @@
 module Voog
   class API
+
+    # Voog Tags API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/tags
     module Tags
 
       # List tags
+      #
+      # @see http://www.voog.com/developers/api/resources/tags#get_tags
       def tags(params = {})
         paginate 'tags', {query: params}
       end
 
       # Get a single tag
+      #
+      # @see http://www.voog.com/developers/api/resources/tags#get_tag
       def tag(id, params = {})
         get "tags/#{id}", {query: params}
       end
 
       # Update a tag
+      #
+      # @see http://www.voog.com/developers/api/resources/tags#update_tag
       def update_tag(id, data)
         put "tags/#{id}", data
       end
 
       # Delete a tag
+      #
+      # @see http://www.voog.com/developers/api/resources/tags#remove_tag
       def delete_tag(id)
         delete "tags/#{id}"
       end

data/lib/voog_api/api/texts.rb

@@ -1,18 +1,28 @@
 module Voog
   class API
+
+    # Voog Text Contents API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/texts
     module Texts
 
       # List text contents
+      #
+      # @see http://www.voog.com/developers/api/resources/texts#get_texts
       def texts(params = {})
         paginate 'texts', {query: params}
       end
 
       # Get a single text content
+      #
+      # @see http://www.voog.com/developers/api/resources/texts#get_text
       def text(id, params = {})
         get "texts/#{id}", {query: params}
       end
 
       # Update a text content
+      #
+      # @see http://www.voog.com/developers/api/resources/texts#update_text
       def update_text(id, data)
         put "texts/#{id}", data
       end

data/lib/voog_api/api/tickets.rb

@@ -1,26 +1,46 @@
 module Voog
   class API
+
+    # Voog Tickets API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/tickets
     module Tickets
 
       # List form tickets
+      #
+      # @see http://www.voog.com/developers/api/resources/tickets#get_tickets
       def tickets(form_id, params = {})
         paginate "forms/#{form_id}/tickets", {query: params}
       end
 
       # Get a single ticket for form
+      #
+      # @see http://www.voog.com/developers/api/resources/tickets#get_ticket
       def ticket(form_id, id, params = {})
         get "forms/#{form_id}/tickets/#{id}", {query: params}
       end
 
       # Delete a form ticket
+      #
+      # @see http://www.voog.com/developers/api/resources/tickets#remove_ticket
       def delete_ticket(form_id, id)
         delete "forms/#{form_id}/tickets/#{id}"
       end
 
       # Delete all spam ticket for form
+      #
+      # @see http://www.voog.com/developers/api/resources/tickets#delete_spam_tickets
       def delete_spam_tickets(form_id)
         delete "forms/#{form_id}/tickets/delete_spam"
       end
+
+      # Delete all or set of ticket for form
+      #
+      # @option params [Array] :ticket_ids array of ticket id that should be removed. All tickets are deleted when this parameter is not provided.
+      # @see http://www.voog.com/developers/api/resources/tickets#delete_tickets
+      def delete_tickets(form_id, params = {})
+        delete "forms/#{form_id}/tickets/delete_tickets", {query: params}
+      end
     end
   end
 end

data/lib/voog_api/client.rb

@@ -19,12 +19,17 @@ require 'voog_api/api/nodes'
 require 'voog_api/api/site'
 require 'voog_api/api/pages'
 require 'voog_api/api/people'
+require 'voog_api/api/search'
+require 'voog_api/api/site_users'
 require 'voog_api/api/tags'
 require 'voog_api/api/texts'
 require 'voog_api/api/tickets'
 
 module Voog
-  
+
+  # Voog API client.
+  #
+  # @see http://www.voog.com/developers/api
   class Client
 
     MAX_PER_PAGE = 250
@@ -44,12 +49,14 @@ module Voog
     include Voog::API::Nodes
     include Voog::API::Pages
     include Voog::API::People
+    include Voog::API::Search
     include Voog::API::Site
+    include Voog::API::SiteUsers
     include Voog::API::Tags
     include Voog::API::Texts
     include Voog::API::Tickets
 
-    attr_reader :api_token, :host, :auto_paginate, :per_page
+    attr_reader :api_token, :host, :protocol, :auto_paginate, :per_page
 
     # Initialize Voog API client.
     #
@@ -96,7 +103,11 @@ module Voog
     end
     
     def api_endpoint
-      "#{@protocol}://#{host}/admin/api"
+      "#{host_with_protocol}/admin/api".freeze
+    end
+
+    def host_with_protocol
+      "#{protocol}://#{host}".freeze
     end
     
     def agent
@@ -128,6 +139,8 @@ module Voog
     end
 
     # Fetch all elements for requested API resource when {#auto_paginate} is turned on.
+    #
+    # @see http://www.voog.com/developers/api/basics/pagination
     def paginate(url, options = {}, &block)
       opts = options.dup
       if @auto_paginate || @per_page
@@ -137,9 +150,7 @@ module Voog
       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)
@@ -161,7 +172,7 @@ module Voog
         multipart_agent.post("#{api_endpoint}/#{path}", data) : \
         agent.call(method, URI.encode(path.to_s), data, options.dup)
 
-      raise Voog::MovedPermanently.new(response.headers['location']) if response.status == 301
+      raise Voog::MovedPermanently.new(response, host_with_protocol) if response.status == 301
 
       if multipart
         parse_response(response.body)

data/lib/voog_api/error.rb

@@ -1,6 +1,13 @@
 module Voog
 
   # Raised when Voog API returns a 301 HTTP status code
-  class MovedPermanently < StandardError; end
+  class MovedPermanently < StandardError
+    attr_reader :response
+
+    def initialize(response, hostname)
+      @response = response
+      super("#{hostname} is permanently redirected to #{response.headers['location'] if response}")
+    end
+  end
 
 end

data/lib/voog_api/version.rb

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

data/spec/fixtures/search/search.json

@@ -0,0 +1,30 @@
+{
+  "result": [{
+    "title": "Having sample news pieces? — Formtest",
+    "description": "from the Blogs section below. By the way, you can add <em>any</em> <em>kind</em> <em>of</em> <em>content</em> to your blog post — text, pictures, tables, forms, and galleries.\n\nThe above is excerpt",
+    "type": "page",
+    "lang": "en",
+    "path": "/blog/having-sample-news-pieces",
+    "tags": [
+      "sample", "news"
+    ],
+    "updated_at": "2013-12-13T09:19:04Z"
+  }, {
+    "title": "Formtest — Blog",
+    "description": ", you can add <em>any</em> <em>kind</em> <em>of</em> <em>content</em> to your blog post — text, pictures, tables, forms, and galleries.\n\nRead more →",
+    "type": "page",
+    "lang": "en",
+    "path": "/blog",
+    "tags": [],
+    "updated_at": "2016-01-01T15:59:18Z"
+  }, {
+    "title": "Formtest — Home page",
+    "description": ", delete, modify <em>any</em> text or pictures as you desire.© My Company 2012. Visit us at 1192 Cambridge Street, Cambridge, MA 02139Call us +1 617-576-1950 Email us at email@yourname.com",
+    "type": "page",
+    "lang": "en",
+    "path": "/en",
+    "tags": [],
+    "updated_at": "2016-01-01T15:59:18Z"
+  }],
+  "time_ms": 28
+}

data/spec/fixtures/site_users/site_user.json

@@ -0,0 +1,9 @@
+{
+  "id": 2,
+  "email": "test2@test.ee",
+  "status": "created",
+  "created_at": "2015-11-05T07:52:55.000Z",
+  "updated_at": "2015-11-05T07:52:55.000Z",
+  "last_login_at": null,
+  "url": "http://voog.test/admin/api/site_users/2"
+}

data/spec/fixtures/site_users/site_users.json

@@ -0,0 +1,20 @@
+[
+  {
+    "id": 1,
+    "email": "test@test.ee",
+    "status": "active",
+    "created_at": "2015-11-05T07:45:02.000Z",
+    "updated_at": "2015-11-05T07:49:16.000Z",
+    "last_login_at": "2015-11-05T07:49:16.000Z",
+    "url": "http://voog.test/admin/api/site_users/1"
+  },
+  {
+    "id": 2,
+    "email": "test2@test.ee",
+    "status": "created",
+    "created_at": "2015-11-05T07:52:55.000Z",
+    "updated_at": "2015-11-05T07:52:55.000Z",
+    "last_login_at": null,
+    "url": "http://voog.test/admin/api/site_users/2"
+  }
+]

data/spec/voog_api/api/articles_spec.rb

@@ -23,7 +23,7 @@ describe Voog::API::Articles do
       expect(client.article(2).title).to eq('How I wrote my first article')
     end
 
-    it 'returns a article with the same id as in the request' do
+    it 'returns an article with the same id as in the request' do
       expect(client.article(2).id).to eq(2)
     end
   end

data/spec/voog_api/api/assets_spec.rb

@@ -23,7 +23,7 @@ describe Voog::API::Assets do
       expect(client.asset(1).filename).to eq('Screen Shot 2014-01-28 at 10.53.26.png')
     end
 
-    it 'returns a asset with the same id as in the request' do
+    it 'returns an asset with the same id as in the request' do
       expect(client.asset(1).id).to eq(1)
     end
   end

data/spec/voog_api/api/forms_spec.rb

@@ -38,4 +38,16 @@ describe Voog::API::Forms do
       expect(client.update_form(2, title: 'Updated title', submit_label: 'Send!').title).to eq('Updated title')
     end
   end
+
+  describe '#delete_form' do
+
+    before do
+      request_fixture(:delete, 'forms/2')
+    end
+
+    it 'calls delete method on form' do
+      client.delete_form(2)
+      assert_requested :delete, 'http://voog.test/admin/api/forms/2'
+    end
+  end
 end

data/spec/voog_api/api/search_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Voog::API::Search do
+
+  let(:client) { voog_client }
+
+  describe '#people' do
+    before do
+      request_fixture(:get, 'search', request: {q: 'any kind of content'}, fixture: 'search/search')
+    end
+
+    it 'returns a list of search results' do
+      expect(client.search.result.length).to eql(3)
+    end
+  end
+end