zendesk_help_center_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b3bc0dbe25b5d814ddf87f31c33a9d054695035
+  data.tar.gz: 0d2fefe1c7f41ed2cc04ac198bda9b89d207de31
+SHA512:
+  metadata.gz: 9a6fb847cab6527af5b4b40f2f6facd627ff4b80679db38b5050cfee2fa8844d4030c5aa8bd8f95e4bb3fbad18401f2829f1200e2a5a00564f4b291dd233e544
+  data.tar.gz: 95b3beb3c5e5b203bff4979b3163443da44f0ed866540f45b1823d3d1052b5d37d2ab42f409be438f36ce911a6ee01079145cda2e895679e648c24134a681973

data/README.md

@@ -0,0 +1,91 @@
+# Zendesk HelpCenter API Client
+
+This gem added support for `Zendesk Help Center` methods under [ZendeskAPI::Client](https://github.com/zendesk/zendesk_api_client_rb) gem.
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zendesk_help_center_api'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install zendesk_help_center_api
+```
+
+## Usage
+
+```ruby
+require 'zendesk_api/help_center'
+```
+
+### Help Center
+
+#### Categories
+
+```ruby
+categories = client.hc_categories
+category = categories.build(name: 'Test Category')
+category.save
+category.update(description: 'This is a test')
+category.destroy
+```
+
+#### Sections
+
+```ruby
+sections = category.sections
+section = sections.first
+category.update(name: 'This is a test')
+```
+
+#### Articles
+
+```ruby
+articles = section.articles
+articles.build(title: 'Test Article')
+category.update(description: 'This is a test')
+article.destroy
+```
+
+### Help Center Translations
+
+```ruby
+categories_tr = category.translations
+category_tr = categories_tr.build(locale: 'uk', name: 'Тестова Стаття')
+category_tr.save
+
+sections_tr = sections.translations
+section_tr = article_tr.build(locale: 'uk', name: 'Це тест')
+section_tr.save
+
+articles_tr = article.translations
+article_tr = article_translations.build(locale: 'uk', title: 'Тестова Стаття')
+article_tr.save
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/mamantoha/zendesk_help_center_api_client_rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/zendesk_api/help_center.rb

@@ -0,0 +1,155 @@
+require 'zendesk_api'
+# require 'byebug'
+
+module ZendeskAPI
+  module HelpCenter
+    include DataNamespace
+
+    class Article < Resource; end
+    class Section < Resource; end
+
+    class Article < Resource
+      class << self
+        def singular_resource_name
+          'article'
+        end
+      end
+    end
+
+    class Section < Resource
+      class << self
+        def singular_resource_name
+          'section'
+        end
+      end
+    end
+
+    class HcCategory < Resource
+      class << self
+        def singular_resource_name
+          'category'
+        end
+      end
+    end
+
+    class HcCategory < Resource
+      class Translation < DataResource
+        extend Read
+        include Create
+        include Update
+        include Destroy
+
+        def initialize(client, attributes = {})
+          attributes["category_id"] ||= attributes.delete('source_id')
+          super
+        end
+
+        # Categorues and sections have the mandatory keys 'name' and 'description'. But in translations used 'title' and 'body' keys.
+        # Here we replace this keys:
+        #
+        # More info:
+        # https://support.zendesk.com/hc/communities/public/posts/204262967-Error-when-creating-new-translation-for-the-section-via-Rest-API
+        #
+        def attributes_for_save
+          attributes[:title] ||= attributes.delete(:name)
+          attributes[:body] ||= attributes.delete(:description)
+
+          attributes
+        end
+
+        def destroy!
+          super do |req|
+            req.path = @client.config.url + "/help_center/translations/" + id.to_s
+          end
+        end
+
+        has HcCategory
+      end
+
+      has_many Translation
+    end
+
+    class Section < Resource
+      class Translation < DataResource
+        extend Read
+        include Create
+        include Update
+        include Destroy
+
+        def initialize(client, attributes = {})
+          attributes["section_id"] ||= attributes.delete('source_id')
+          super
+        end
+
+        def attributes_for_save
+          attributes[:title] ||= attributes.delete(:name)
+          attributes[:body] ||= attributes.delete(:description)
+
+          attributes
+        end
+
+        def destroy!
+          super do |req|
+            req.path = @client.config.url + "/help_center/translations/" + id.to_s
+          end
+        end
+
+        has Section
+      end
+
+      has_many Translation
+    end
+
+    class Article < Resource
+      class Translation < DataResource
+        extend Read
+        include Create
+        include Update
+        include Destroy
+
+        def initialize(client, attributes = {})
+          attributes["article_id"] ||= attributes.delete('source_id')
+          super
+        end
+
+        def destroy!
+          super do |req|
+            req.path = @client.config.url + "/help_center/translations/" + id.to_s
+          end
+        end
+
+        has Article
+      end
+
+      has_many Translation
+    end
+
+    class HcCategory < Resource
+      namespace "help_center"
+
+      has_many Section
+      has_many Article
+    end
+
+    class Section < Resource
+      namespace "help_center"
+
+      has HcCategory
+      has_many Article
+
+      def save!(*)
+        category = @association.options.parent
+        super do |req|
+          req.path = "help_center/categories/#{category.id}/sections"
+        end
+      end
+    end
+
+    class Article < Resource
+      namespace "help_center"
+
+      has HcCategory
+      has Section
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: zendesk_help_center_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Maminov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zendesk_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the REST API at http://www.zendesk.com. Documentation
+  at https://developer.zendesk.com/rest_api/docs/help_center/introduction.
+email:
+- anton.linux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/zendesk_api/help_center.rb
+homepage: https://github.com/mamantoha/zendesk_help_center_api_client_rb
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Zendesk Help Center REST API Client
+test_files: []