zendesk2 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4b6c9e3a2263e5d8e84d8c0d408c2a40d898106
-  data.tar.gz: db66a761d97b525ef31cb6d63ae5b6d28b5751fe
+  metadata.gz: 9e80f873dd170c7aa2f3a62268d1e2580228f5c5
+  data.tar.gz: 4eca8baf6dd0b2f4be9d2b2a4879dd77c78cec69
 SHA512:
-  metadata.gz: f14e79bbd8b508ce7f9d22e31e4249f85ffeb4fd153b4ae244ac79293425b76ab63253c7ea8723cb1b57be64376f9dd8637ee034a25a24917d61b99e2deeb704
-  data.tar.gz: a8b6cc3a9da6ecd75fe1174a59b790076b9f2c51004318199e9b759c634008aa6bac5a57b276125315c53c610380b5290aaf8f4e012061c9ae3543e51262c9b0
+  metadata.gz: 717c640ad7636fefe296d93c3c75f317fb83e758bc08c2fda527abbf2c917adb364d484cbdf75753d92a966442d6eabf58c5deb6224f0bc34474d064bfb35e21
+  data.tar.gz: 5a635a1179e896ab3cfcc00aa1b6751310afb29f803d8775ab3cd65c0e3ab004c6d69257db0e617eedfdfc95e682890fe8c1461c54e8f567b6164966199007c7

data/.travis.yml

@@ -5,7 +5,6 @@ cache:
 rvm:
   - 2.3.0
   - 2.2.4
-  - 2.1.8
 script: 
   - bundle exec rubocop -Da
   - bundle exec rake spec

data/CHANGELOG.md

@@ -2,7 +2,28 @@
 
 ## [Unreleased](https://github.com/lanej/zendesk2/tree/HEAD)
 
-[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.8.1...HEAD)
+[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.10.0...HEAD)
+
+**Implemented enhancements:**
+
+- Please add support to Help Center subscriptions [\#43](https://github.com/lanej/zendesk2/issues/43)
+- feature\(hc\): add subscriptions [\#54](https://github.com/lanej/zendesk2/pull/54) ([lanej](https://github.com/lanej))
+
+## [v1.10.0](https://github.com/lanej/zendesk2/tree/v1.10.0) (2016-07-01)
+[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.9.0...v1.10.0)
+
+**Implemented enhancements:**
+
+- feature\(hc\): posts [\#56](https://github.com/lanej/zendesk2/pull/56) ([lanej](https://github.com/lanej))
+- feature\(hc\): add topics [\#55](https://github.com/lanej/zendesk2/pull/55) ([lanej](https://github.com/lanej))
+
+**Merged pull requests:**
+
+- Add locale option to categories endpoint [\#53](https://github.com/lanej/zendesk2/pull/53) ([codeminator](https://github.com/codeminator))
+- Enable rubocop [\#52](https://github.com/lanej/zendesk2/pull/52) ([lanej](https://github.com/lanej))
+
+## [v1.9.0](https://github.com/lanej/zendesk2/tree/v1.9.0) (2016-05-25)
+[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.8.1...v1.9.0)
 
 **Merged pull requests:**
 

data/Gemfile

@@ -8,9 +8,9 @@ gem 'rake'
 # To avoid warnings from JWT
 gem 'json', '~> 1.8'
 gem 'rubocop', '~> 0.41', require: false
-gem 'pry-nav'
 
 group :test do
+  gem 'pry-nav'
   gem 'awesome_print'
   gem 'rspec', '~> 3.2'
   gem 'rack-test'

data/lib/zendesk2/help_center.rb

@@ -2,19 +2,22 @@
 module Zendesk2::HelpCenter; end
 
 require 'zendesk2/help_center/translation_source'
+require 'zendesk2/help_center/subscription_request'
 
 require 'zendesk2/help_center/create_help_center_article'
 require 'zendesk2/help_center/create_help_center_category'
 require 'zendesk2/help_center/create_help_center_post'
 require 'zendesk2/help_center/create_help_center_section'
+require 'zendesk2/help_center/create_help_center_subscription'
 require 'zendesk2/help_center/create_help_center_topic'
 require 'zendesk2/help_center/create_help_center_translation'
 require 'zendesk2/help_center/destroy_help_center_article'
 require 'zendesk2/help_center/destroy_help_center_category'
 require 'zendesk2/help_center/destroy_help_center_post'
 require 'zendesk2/help_center/destroy_help_center_section'
-require 'zendesk2/help_center/destroy_help_center_translation'
 require 'zendesk2/help_center/destroy_help_center_topic'
+require 'zendesk2/help_center/destroy_help_center_subscription'
+require 'zendesk2/help_center/destroy_help_center_translation'
 require 'zendesk2/help_center/get_help_center_access_policy'
 require 'zendesk2/help_center/get_help_center_article'
 require 'zendesk2/help_center/get_help_center_articles'
@@ -27,10 +30,13 @@ require 'zendesk2/help_center/get_help_center_posts'
 require 'zendesk2/help_center/get_help_center_section'
 require 'zendesk2/help_center/get_help_center_sections'
 require 'zendesk2/help_center/get_help_center_sections_articles'
+require 'zendesk2/help_center/get_help_center_subscription'
+require 'zendesk2/help_center/get_help_center_subscriptions'
 require 'zendesk2/help_center/get_help_center_topic'
 require 'zendesk2/help_center/get_help_center_topics'
 require 'zendesk2/help_center/get_help_center_translation'
 require 'zendesk2/help_center/get_help_center_translations'
+require 'zendesk2/help_center/get_users_help_center_subscriptions'
 require 'zendesk2/help_center/search_help_center_articles'
 require 'zendesk2/help_center/update_help_center_access_policy'
 require 'zendesk2/help_center/update_help_center_article'
@@ -38,6 +44,7 @@ require 'zendesk2/help_center/update_help_center_category'
 require 'zendesk2/help_center/update_help_center_post'
 require 'zendesk2/help_center/update_help_center_section'
 require 'zendesk2/help_center/update_help_center_topic'
+require 'zendesk2/help_center/update_help_center_subscription'
 require 'zendesk2/help_center/update_help_center_translation'
 
 require 'zendesk2/help_center/access_policy'
@@ -45,6 +52,7 @@ require 'zendesk2/help_center/article'
 require 'zendesk2/help_center/category'
 require 'zendesk2/help_center/post'
 require 'zendesk2/help_center/section'
+require 'zendesk2/help_center/subscription'
 require 'zendesk2/help_center/topic'
 require 'zendesk2/help_center/translation'
 
@@ -52,5 +60,6 @@ require 'zendesk2/help_center/articles'
 require 'zendesk2/help_center/categories'
 require 'zendesk2/help_center/posts'
 require 'zendesk2/help_center/sections'
+require 'zendesk2/help_center/subscriptions'
 require 'zendesk2/help_center/topics'
 require 'zendesk2/help_center/translations'

data/lib/zendesk2/help_center/article.rb

@@ -54,6 +54,12 @@ class Zendesk2::HelpCenter::Article
     cistern.help_center_translations(source_id: identity, source_type: 'Article')
   end
 
+  def subscriptions
+    requires :identity
+
+    cistern.help_center_subscriptions(content_id: identity, content_type: 'article')
+  end
+
   def save!
     response = if new_record?
                  requires :title, :locale, :section_id

data/lib/zendesk2/help_center/create_help_center_subscription.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+class Zendesk2::CreateHelpCenterSubscription
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::SubscriptionRequest
+
+  request_method :post
+  request_path { |r| "/#{r.route_prefix}/#{r.plural_content_type}/#{r.content_id}/subscriptions.json" }
+  request_body do |r|
+    { 'subscription' => r.subscription_params } if r.subscription_params.any?
+  end
+
+  def subscription_params
+    return @subscription_params if @subscription_params
+    body = Cistern::Hash.slice(subscription, *self.class.accepted_attributes(content_type))
+    body['source_locale'] = body.delete('locale') if body['locale']
+    @subscription_params = body
+  end
+
+  def mock
+    identity = cistern.serial_id
+
+    url = url_for("/help_center/#{plural_content_type}/#{content_id}/subscription.json")
+
+    content_collection = "help_center_#{plural_content_type}".to_sym
+    find!(content_collection, content_id)
+
+    if subscription_params.empty?
+      mock_response('Required parameter missing: subscription', status: 400)
+    end
+
+
+    record = subscription_params.merge(
+      'id'           => identity,
+      'url'          => url,
+      'created_at'   => Time.now.iso8601, # @todo create #timestamp helper
+      'updated_at'   => Time.now.iso8601,
+      'content_id'   => content_id,
+      'content_type' => content_type,
+    )
+
+    record['locale'] = record.delete('source_locale') if record['source_locale']
+
+    cistern.data[:help_center_subscriptions][identity] = record
+
+    mock_response('subscription' => record)
+  end
+end

data/lib/zendesk2/help_center/destroy_help_center_subscription.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class Zendesk2::DestroyHelpCenterSubscription
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::SubscriptionRequest
+
+  request_method :delete
+  request_path do |r|
+    route = "/#{r.route_prefix}/#{r.plural_content_type}/#{r.content_id}"
+    route + "/subscriptions/#{r.subscription_id}.json"
+  end
+
+  def mock
+    content_collection = "help_center_#{plural_content_type}".to_sym
+    find!(content_collection, content_id)
+
+    delete!(:help_center_subscriptions, subscription_id)
+
+    mock_response(nil, status: 204)
+  end
+end

data/lib/zendesk2/help_center/get_help_center_subscription.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+class Zendesk2::GetHelpCenterSubscription
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::SubscriptionRequest
+
+  request_method :get
+  request_path do |r|
+    content_path = "/#{r.route_prefix}/#{r.plural_content_type}"
+    content_path + "/#{r.content_id}/subscriptions/#{r.subscription_id}.json"
+  end
+
+  def mock(_params = {})
+    mock_response('subscription' => find!(:help_center_subscriptions, subscription_id))
+  end
+end

data/lib/zendesk2/help_center/get_help_center_subscriptions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+class Zendesk2::GetHelpCenterSubscriptions
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::SubscriptionRequest
+
+  request_path { |r| "/#{r.route_prefix}/#{r.plural_content_type}/#{r.content_id}/subscriptions.json" }
+
+  page_params!
+
+  def content_type
+    params.fetch('content_type')
+  end
+
+  def content_id
+    params.fetch('content_id').to_i
+  end
+
+  def mock
+    article_subscriptions = cistern.data[:help_center_subscriptions].values.select do |sub|
+      sub['content_id'] == content_id
+    end
+
+    page(article_subscriptions, root: 'subscriptions')
+  end
+end

data/lib/zendesk2/help_center/get_users_help_center_subscriptions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class Zendesk2::GetUsersHelpCenterSubscriptions
+  include Zendesk2::Request
+
+  request_path { |r| "/help_center/users/#{r.user_id}/subscriptions.json" }
+
+  page_params!
+
+  def user_id
+    params.fetch('user_id').to_i
+  end
+
+  def mock
+    article_subscriptions = cistern.data[:help_center_subscriptions].values.select do |sub|
+      sub['user_id'] == user_id
+    end
+
+    page(article_subscriptions, root: 'subscriptions')
+  end
+end

data/lib/zendesk2/help_center/post.rb

@@ -61,7 +61,7 @@ class Zendesk2::HelpCenter::Post
   end
 
   def author
-    author_id && cistern.users.get!(author_id)
+    cistern.users.get!(author_id) if author_id
   end
 
   def topic
@@ -69,4 +69,10 @@ class Zendesk2::HelpCenter::Post
 
     cistern.help_center_topics.get!(topic_id)
   end
+
+  def subscriptions
+    requires :identity
+
+    cistern.help_center_subscriptions(content_id: identity, content_type: 'post')
+  end
 end

data/lib/zendesk2/help_center/section.rb

@@ -73,6 +73,12 @@ class Zendesk2::HelpCenter::Section
     cistern.help_center_access_policy(response)
   end
 
+  def subscriptions
+    requires :identity
+
+    cistern.help_center_subscriptions(content_id: identity, content_type: 'section')
+  end
+
   def translations
     requires :identity
 

data/lib/zendesk2/help_center/subscription.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+class Zendesk2::HelpCenter::Subscription
+  include Zendesk2::Model
+
+  extend Zendesk2::Attributes
+
+  # @return [Integer] Automatically assigned when the subscription is created
+  identity :id, type: :integer # ro: yes, required: no
+
+  # @return [String] The API url of the subscription
+  attribute :url # ro: yes, required: no
+  # @return [Integer] The id of the user who has this subscription
+  attribute :user_id, type: :integer # ro: yes, required: no
+  # @return [Integer] The id of the subscribed item
+  attribute :content_id, type: :integer # ro: yes, required: no
+  # @return [String] The type of the subscribed item
+  attribute :content_type # ro: yes, required: no
+  # @return [String] The locale of the subscribed item
+  attribute :locale # ro: yes, required: yes
+  # @return [Boolean] Subscribe also to article comments. Only for section subscriptions.
+  attribute :include_comments, type: :boolean # ro: yes, required: no
+  # @return [Time] The time at which the subscription was created
+  attribute :created_at, type: :time # ro: yes, required: no
+  # @return [Time] The time at which the subscription was last updated
+  attribute :updated_at, type: :time # ro: yes, required: no
+
+  def destroy!
+    requires :identity
+
+    cistern.destroy_help_center_subscription('subscription' => attributes)
+  end
+
+  def save!
+    response = if new_record?
+                 requires :content_id, :content_type
+
+                 cistern.create_help_center_subscription('subscription' => attributes)
+               else
+                 requires :identity
+
+                 cistern.update_help_center_subscription('subscription' => attributes)
+               end
+
+    merge_attributes(response.body['subscription'])
+  end
+end

data/lib/zendesk2/help_center/subscription_request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Zendesk2::HelpCenter::SubscriptionRequest
+
+  def self.included(klass)
+    super
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def accepted_attributes(type)
+      case type
+      when 'topic'
+        %w(include_comments user_id)
+      when 'post'
+        %w(user_id)
+      else
+        %w(locale user_id)
+      end
+    end
+  end
+
+  def route_prefix
+    case content_type
+    when 'topic', 'post'
+      'community'
+    else
+      'help_center'
+    end
+  end
+
+  def plural_content_type
+    pluralize(content_type)
+  end
+
+  def content_type
+    subscription.fetch('content_type')
+  end
+
+  def content_id
+    subscription.fetch('content_id').to_i
+  end
+
+  def subscription_id
+    subscription.fetch('id')
+  end
+
+  def subscription
+    Cistern::Hash.stringify_keys(params.fetch('subscription'))
+  end
+end

data/lib/zendesk2/help_center/subscriptions.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+class Zendesk2::HelpCenter::Subscriptions
+  include Zendesk2::Collection
+  include Zendesk2::PagedCollection
+
+  include Zendesk2::Searchable
+
+  model Zendesk2::HelpCenter::Subscription
+
+  self.collection_method = :get_help_center_subscriptions
+  self.collection_root   = 'subscriptions'
+  self.model_method      = :get_help_center_subscription
+  self.model_root        = 'subscription'
+
+  attribute :content_id, type: :integer
+  attribute :content_type, type: :string
+  attribute :user_id, type: :integer
+
+  scopes << :content_id
+  scopes << :content_type
+  scopes << :user_id
+
+  def collection_method
+    user_id ? :get_users_help_center_subscriptions : super
+  end
+
+  def get!(*args)
+    requires :content_id, :content_type
+
+    super
+  end
+end

data/lib/zendesk2/help_center/topic.rb

@@ -49,4 +49,10 @@ class Zendesk2::HelpCenter::Topic
 
     cistern.help_center_posts(topic_id: identity)
   end
+
+  def subscriptions
+    requires :identity
+
+    cistern.help_center_subscriptions(content_id: identity, content_type: 'topic')
+  end
 end

data/lib/zendesk2/help_center/update_help_center_subscription.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+class Zendesk2::UpdateHelpCenterSubscription
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::SubscriptionRequest
+
+  request_method :put
+  request_path { |r| "/#{r.route_prefix}/#{r.plural_content_type}/#{r.content_id}/subscriptions.json" }
+  request_body do |r|
+    { 'subscription' => r.subscription_params } if r.subscription_params.any?
+  end
+
+  def subscription_params
+    return @subscription_params if @subscription_params
+    body = Cistern::Hash.slice(subscription, *self.class.accepted_attributes(content_type))
+    body['source_locale'] = body.delete('locale') if body['locale']
+    @subscription_params = body
+  end
+
+  def mock
+    subscription = find!(:help_center_subscriptions, subscription_id)
+
+    if subscription_params.empty?
+      mock_response('Required parameter missing: subscription', status: 400)
+    end
+
+    updated = subscription_params
+    updated['locale'] = updated.delete('source_locale') if updated['source_locale']
+    updated['updated_at'] = Time.now.iso8601
+
+    subscription.merge!(updated)
+
+    mock_response('subscription' => subscription)
+  end
+end

data/lib/zendesk2/mock.rb

@@ -14,6 +14,7 @@ class Zendesk2::Mock
         help_center_categories: {},
         help_center_posts: {},
         help_center_sections: {},
+        help_center_subscriptions: {},
         help_center_topics: {},
         help_center_translations: {},
         identities: {},

data/lib/zendesk2/user.rb

@@ -190,6 +190,13 @@ class Zendesk2::User
     cistern.organizations(user: self)
   end
 
+  # @return [Zendesk2::HelpCenter::Subscriptions] subscriptions
+  def subscriptions
+    requires :identity
+
+    cistern.help_center_subscriptions(user_id: identity)
+  end
+
   # @return [Zendesk2::HelpCenter::Post] authored posts
   def posts
     requires :identity

data/lib/zendesk2/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Zendesk2
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'
 end

data/spec/help_center/articles_spec.rb

@@ -17,20 +17,4 @@ describe 'help_center/articles' do
                    update_params: -> { { title: mock_uuid } },
                    search_params: -> { Cistern::Hash.slice(create_params, :title) },
                    search: true
-
-  describe 'translations' do
-    let!(:article) do
-      client.help_center_articles.create!(title: mock_uuid,
-                                          locale: 'en-us',
-                                          section: section)
-    end
-    let!(:locale) { mock_uuid }
-
-    include_examples 'zendesk#resource',
-                     collection: -> { article.translations },
-                     fetch_params: ->(r) { Cistern::Hash.slice(r.attributes, :source_id, :source_type, :locale) },
-                     create_params: -> { { source: article, locale: locale, title: mock_uuid } },
-                     update_params: -> { { title: mock_uuid } },
-                     search: false
-  end
 end

data/spec/help_center/categories_spec.rb

@@ -28,16 +28,4 @@ describe 'help_center/categories' do
       expect(category.articles.all).to match_array(articles)
     end
   end
-
-  describe 'translations' do
-    let!(:category) { client.help_center_categories.create!(name: mock_uuid, locale: 'en-us') }
-    let!(:locale) { mock_uuid }
-
-    include_examples 'zendesk#resource',
-                     collection: -> { category.translations },
-                     fetch_params: ->(r) { Cistern::Hash.slice(r.attributes, :source_id, :source_type, :locale) },
-                     create_params: -> { { source: category, locale: locale, title: mock_uuid } },
-                     update_params: -> { { title: mock_uuid } },
-                     search: false
-  end
 end

data/spec/help_center/sections_spec.rb

@@ -43,17 +43,4 @@ describe 'help_center/sections' do
       end.to change { section.reload.access_policy.viewable_by }.from(old_viewable_by).to(new_viewable_by)
     end
   end
-
-  describe 'translations' do
-    let!(:category) { client.help_center_categories.create!(name: mock_uuid, locale: 'en-us') }
-    let!(:section)  { category.sections.create!(name: mock_uuid, locale: 'en-us') }
-    let!(:locale) { mock_uuid }
-
-    include_examples 'zendesk#resource',
-                     collection: -> { section.translations },
-                     fetch_params: ->(r) { Cistern::Hash.slice(r.attributes, :source_id, :source_type, :locale) },
-                     create_params: -> { { source: section, locale: locale, title: mock_uuid } },
-                     update_params: -> { { title: mock_uuid } },
-                     search: false
-  end
 end

data/spec/help_center/subscriptions_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe 'help_center/subscriptions' do
+  let(:client) { create_client }
+  let(:category) { client.help_center_categories.create!(name: mock_uuid, locale: 'en-us') }
+  let(:section) do
+    client.help_center_sections.create!(name: mock_uuid,
+                                        locale: 'en-us',
+                                        category: category)
+  end
+
+  describe 'with an article' do
+    let!(:article) do
+      client.help_center_articles.create!(title: mock_uuid,
+                                          locale: 'en-us',
+                                          section: section)
+    end
+
+    include_examples 'zendesk#resource',
+                     collection: -> { article.subscriptions },
+                     create_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id, locale: 'en-us' }
+                                    },
+                     update_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id, locale: 'en-gb' }
+                                    },
+                     search: false
+  end
+
+  describe 'with an section' do
+    before { section }
+
+    include_examples 'zendesk#resource',
+                     collection: -> { section.subscriptions },
+                     create_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id, locale: 'en-us' }
+                                    },
+                     update_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id, locale: 'en-gb' }
+                                    },
+                     search: false
+  end
+
+  describe 'with a topic' do
+    let!(:topic) { client.help_center_topics.create(name: mock_uuid) }
+
+    include_examples 'zendesk#resource',
+                     collection: -> { topic.subscriptions },
+                     create_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id, include_comments: true }
+                                    },
+                     update_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id, include_comments: false }
+                                    },
+                     search: false
+  end
+
+  describe 'with a post' do
+    let!(:topic) { client.help_center_topics.create(name: mock_uuid) }
+    let!(:author)  do
+      client.users.create!(
+        email: mock_email,
+        name: mock_uuid,
+      )
+    end
+    let!(:post) do
+      client.help_center_posts.create(
+        title: mock_uuid,
+        details: mock_uuid,
+        topic_id: topic.id,
+        author_id: author.id,
+      )
+    end
+
+    include_examples 'zendesk#resource',
+                     collection: -> { post.subscriptions },
+                     create_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id }
+                                    },
+                     update_params: lambda {
+                                      subscriber = client.users.create!(
+                                        email: mock_email,
+                                        name: mock_uuid,
+                                      )
+                                      { user_id: subscriber.id }
+                                    },
+                     search: false
+  end
+
+  it 'lists subscription by user' do
+    subscriber = client.users.create!(
+      email: mock_email,
+      name: mock_uuid,
+    )
+
+    subscription = section.subscriptions.create(user_id: subscriber.id, locale: 'en-us')
+
+    expect(subscriber.subscriptions).to include(subscription)
+  end
+end

data/spec/help_center/translations_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe 'help_center/translations' do
+  let(:client) { create_client }
+  let!(:locale) { mock_uuid }
+  let!(:category) { client.help_center_categories.create!(name: mock_uuid, locale: 'en-us') }
+
+  let(:section) { category.sections.create!(name: mock_uuid, locale: 'en-us') }
+
+  describe 'by category' do
+    include_examples 'zendesk#resource',
+                     collection: -> { category.translations },
+                     fetch_params: ->(r) { Cistern::Hash.slice(r.attributes, :source_id, :source_type, :locale) },
+                     create_params: -> { { source: category, locale: locale, title: mock_uuid } },
+                     update_params: -> { { title: mock_uuid } },
+                     search: false
+  end
+
+  describe 'by section' do
+    before { section }
+
+    include_examples 'zendesk#resource',
+                     collection: -> { section.translations },
+                     fetch_params: ->(r) { Cistern::Hash.slice(r.attributes, :source_id, :source_type, :locale) },
+                     create_params: -> { { source: section, locale: locale, title: mock_uuid } },
+                     update_params: -> { { title: mock_uuid } },
+                     search: false
+  end
+
+  describe 'by article' do
+    let!(:article) { client.help_center_articles.create!(title: mock_uuid, locale: 'en-us', section: section) }
+
+    include_examples 'zendesk#resource',
+                     collection: -> { article.translations },
+                     fetch_params: ->(r) { Cistern::Hash.slice(r.attributes, :source_id, :source_type, :locale) },
+                     create_params: -> { { source: article, locale: locale, title: mock_uuid } },
+                     update_params: -> { { title: mock_uuid } },
+                     search: false
+  end
+end

data/spec/shared/zendesk_resource.rb

@@ -23,7 +23,9 @@ shared_examples 'zendesk#resource' do |options = {}|
     if options.fetch(:paged, true)
       context 'paging' do
         before(:each) do
-          @resources = Array.new(3) { collection.create!(instance_exec(&options[:create_params])) }
+          if collection.reload.count < 3
+            @resources = Array.new(3) { collection.create!(instance_exec(&options[:create_params])) }
+          end
         end
 
         after(:each) { (@resources || []).each(&:destroy) }
@@ -77,13 +79,15 @@ shared_examples 'zendesk#resource' do |options = {}|
       end
     end
 
-    it 'should be destroyed' do
-      @record = collection.create!(create_params)
-      expect(record.identity).not_to be_nil
-      record.destroy
+    if options.fetch(:destroy, true)
+      it 'should be destroyed' do
+        @record = collection.create!(create_params)
+        expect(record.identity).not_to be_nil
+        record.destroy
 
-      if !options.fetch(:delayed_destroy, false) && !Zendesk2.mocking?
-        expect(record).to be_destroyed
+        if !options.fetch(:delayed_destroy, false) && !Zendesk2.mocking?
+          expect(record).to be_destroyed
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -173,12 +173,14 @@ files:
 - lib/zendesk2/help_center/create_help_center_category.rb
 - lib/zendesk2/help_center/create_help_center_post.rb
 - lib/zendesk2/help_center/create_help_center_section.rb
+- lib/zendesk2/help_center/create_help_center_subscription.rb
 - lib/zendesk2/help_center/create_help_center_topic.rb
 - lib/zendesk2/help_center/create_help_center_translation.rb
 - lib/zendesk2/help_center/destroy_help_center_article.rb
 - lib/zendesk2/help_center/destroy_help_center_category.rb
 - lib/zendesk2/help_center/destroy_help_center_post.rb
 - lib/zendesk2/help_center/destroy_help_center_section.rb
+- lib/zendesk2/help_center/destroy_help_center_subscription.rb
 - lib/zendesk2/help_center/destroy_help_center_topic.rb
 - lib/zendesk2/help_center/destroy_help_center_translation.rb
 - lib/zendesk2/help_center/get_help_center_access_policy.rb
@@ -193,15 +195,21 @@ files:
 - lib/zendesk2/help_center/get_help_center_section.rb
 - lib/zendesk2/help_center/get_help_center_sections.rb
 - lib/zendesk2/help_center/get_help_center_sections_articles.rb
+- lib/zendesk2/help_center/get_help_center_subscription.rb
+- lib/zendesk2/help_center/get_help_center_subscriptions.rb
 - lib/zendesk2/help_center/get_help_center_topic.rb
 - lib/zendesk2/help_center/get_help_center_topics.rb
 - lib/zendesk2/help_center/get_help_center_translation.rb
 - lib/zendesk2/help_center/get_help_center_translations.rb
+- lib/zendesk2/help_center/get_users_help_center_subscriptions.rb
 - lib/zendesk2/help_center/post.rb
 - lib/zendesk2/help_center/posts.rb
 - lib/zendesk2/help_center/search_help_center_articles.rb
 - lib/zendesk2/help_center/section.rb
 - lib/zendesk2/help_center/sections.rb
+- lib/zendesk2/help_center/subscription.rb
+- lib/zendesk2/help_center/subscription_request.rb
+- lib/zendesk2/help_center/subscriptions.rb
 - lib/zendesk2/help_center/topic.rb
 - lib/zendesk2/help_center/topics.rb
 - lib/zendesk2/help_center/translation.rb
@@ -212,6 +220,7 @@ files:
 - lib/zendesk2/help_center/update_help_center_category.rb
 - lib/zendesk2/help_center/update_help_center_post.rb
 - lib/zendesk2/help_center/update_help_center_section.rb
+- lib/zendesk2/help_center/update_help_center_subscription.rb
 - lib/zendesk2/help_center/update_help_center_topic.rb
 - lib/zendesk2/help_center/update_help_center_translation.rb
 - lib/zendesk2/logger.rb
@@ -279,7 +288,9 @@ files:
 - spec/help_center/categories_spec.rb
 - spec/help_center/posts_spec.rb
 - spec/help_center/sections_spec.rb
+- spec/help_center/subscriptions_spec.rb
 - spec/help_center/topics_spec.rb
+- spec/help_center/translations_spec.rb
 - spec/lib/paged_collection_spec.rb
 - spec/lib/rate_limit_spec.rb
 - spec/memberships_spec.rb
@@ -331,7 +342,9 @@ test_files:
 - spec/help_center/categories_spec.rb
 - spec/help_center/posts_spec.rb
 - spec/help_center/sections_spec.rb
+- spec/help_center/subscriptions_spec.rb
 - spec/help_center/topics_spec.rb
+- spec/help_center/translations_spec.rb
 - spec/lib/paged_collection_spec.rb
 - spec/lib/rate_limit_spec.rb
 - spec/memberships_spec.rb
@@ -349,3 +362,4 @@ test_files:
 - spec/users_spec.rb
 - spec/views_spec.rb
 - spec/zendesk2_spec.rb
+has_rdoc: