dimelo_ccp_api 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4962e1ddaa81b7ef970c119cbd677c7fc3a59fc1
+  data.tar.gz: 34a481ab52fcea68f15dce8208b0c77b24ae51f2
+SHA512:
+  metadata.gz: 0ed9b3e676d8ad3f03370e33099b8d93e12f04f6768e49fb067db1689073da37db7deed45f0a9e9fd7af7e3fc4d924bf94baefb1dc479c2349b2a3b337efa233
+  data.tar.gz: c6db38d30585780a991826a384532b8f89a049ed4c8a5f56cfc507b8034c63f1a61df1aebbc8782fe9efb92a3c0cc92bf4a4366a4931924614eb1bdb8d7698ad

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.idea
+.rbenv-version
+Gemfile.lock
+pkg/*

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - ruby-head
+  - jruby-head
+gemfile:
+  - gemfiles/Gemfile.activesupport-3.2.x
+  - gemfiles/Gemfile.activesupport-4.0.x
+  - gemfiles/Gemfile.activesupport-4.1.x
+  - gemfiles/Gemfile.activesupport-edge
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/Gemfile.activesupport-edge

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# 0.3.3
+
+Remove warning when attribute is present in api but not defined in model
+
+# 0.3.2
+
+Implement webhook as a standard resource instead of crappy built-in stuff
+
+# 0.3.1
+
+Add a feature to push a webhook API configuration through API
+
+# 0.2.2
+
+Fix handling of validation errors, they now return status 422 and were incorrectely raise.
+This fix restores the previous behaviour: returning a Dimelo record with AR errors.
+
+# 0.2.1
+
+Attempt to fix segfault in model.rb:116 (#inspect)
+Fix HTTPS spec with github
+
+# 0.2.0
+
+Added support for Role + upgrade to Rspec 3
+
+# 0.0.4
+
+Support http_options for Client.new to be able to set dedicated timeout

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dimelo_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2006-2014 Dimelo SA
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Dimelo CCP API [![Build Status](https://travis-ci.org/dimelo/dimelo_ccp_api.svg?branch=master)](https://travis-ci.org/dimelo/dimelo_ccp_api) [![Code Climate](https://codeclimate.com/github/dimelo/dimelo_ccp_api.png)](https://codeclimate.com/github/dimelo/dimelo_ccp_api)
+
+Ruby client for the Dimelo Customer Community Platform
+
+This client support most of Dimelo CCP resources, can read and write them, paginates with cursor like interface, supports attachments and supports proper validation and error format.
+
+This is heavily used internaly at Dimelo.
+
+# Compatibility
+
+Compatible and tested with:
+
+- Ruby 2.0, 2.1, 2.2 and Jruby-head
+- ActiveSupport 3.0+, 4.0.x and 4.1.x
+
+
+## Installation
+
+Gemfile:
+
+```ruby
+gem 'dimelo_ccp_api'
+```
+
+## Usage
+
+```ruby
+require 'dimelo_ccp_api'
+
+
+users_client = Dimelo::CCP::API::Client.new('https://domain-test.api.users.dimelo.com/1.0', 'access_token' => ENV['DIMELO_CCP_TOKEN'])
+answers_client = Dimelo::CCP::API::Client.new('https://domain-test.api.answers.dimelo.com/1.0', 'access_token' => ENV['DIMELO_CCP_TOKEN'])
+feedbacks_client = Dimelo::CCP::API::Client.new('https://domain-test.api.ideas.dimelo.com/1.0', 'access_token' => ENV['DIMELO_CCP_TOKEN'])
+
+user = Dimelo::CCP::User.find(1, users_client)
+questions = user.questions(answers_client)
+puts "question count: #{questions.count}"
+
+questions.each do |question, i|
+  answers = question.answers
+  puts "#{i} of #{questions.count} => answer count: #{answers.count}"
+  answers.each do |answer|
+    answer.question_flow_state = "lol"
+  end
+end
+
+feedbacks = Dimelo::CCP::Feedback.find({ :order => 'updated_at.desc' }, feedbacks_client)
+puts "feedbacks count: #{feedbacks.count}"
+puts "feedbacks not by anonymous and superadmin: #{feedbacks.select{|f| f.user_id.present?}.count}"
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/dimelo/dimelo_ccp_api/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 new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require "spec/rake/spectask"  # RSpec 1.3
+
+  desc 'Run all specs in spec directory.'
+  Spec::Rake::SpecTask.new(:spec) do |task|
+    task.libs = ['lib', 'spec']
+    task.spec_files = FileList['spec/**/*_spec.rb']
+  end
+rescue LoadError
+  require "rspec/core/rake_task" # RSpec 2.0
+
+  desc 'Run all specs in spec directory.'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w{--colour --format progress}
+    t.pattern = 'spec/**/*_spec.rb'
+  end  
+end
+
+desc 'Default: runs specs.'
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/dimelo_ccp_api.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dimelo/ccp/api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dimelo_ccp_api"
+  s.version     = Dimelo::CCP::API::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jean Boussier", "Renaud Morvan"]
+  s.email       = ["jean.boussier@dimelo.com", "nel@w3fu.com"]
+  s.homepage    = ""
+  s.summary     = %q{Dimelo CCP v2 API client}
+  s.description = %q{Rest API client for Dimelo CCP v2 plateform}
+
+  s.rubyforge_project = "dimelo_ccp_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency('activesupport', '>= 3.0.0')
+  s.add_dependency('activemodel', '>= 3.0.0')
+  s.add_dependency('faraday')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 3.0')
+end

data/examples/dimelo_api_test

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler'
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'dimelo_api'
+require 'pp'
+
+unless ENV['DIMELO_API_KEY'].present?
+  puts "Don't forget to set your api key"
+  exit 1
+end
+
+
+users_client = Dimelo::CCP::API::Client.new('https://domain-test.api.users.dimelo.com/1.0', 'access_token' => ENV['DIMELO_API_KEY'])
+answers_client = Dimelo::CCP::API::Client.new('https://domain-test.api.answers.dimelo.com/1.0', 'access_token' => ENV['DIMELO_API_KEY'])
+feedbacks_client = Dimelo::CCP::API::Client.new('https://domain-test.api.ideas.dimelo.com/1.0', 'access_token' => ENV['DIMELO_API_KEY'])
+
+user = Dimelo::API::User.find(1, users_client)
+questions = user.questions(answers_client)
+puts "question count: #{questions.count}"
+
+questions.each do |question, i|
+  answers = question.answers
+  puts "#{i} of #{questions.count} => answer count: #{answers.count}"
+  answers.each do |answer|
+    answer.question_flow_state = "lol"
+  end
+end
+
+feedbacks = Dimelo::API::Feedback.find({ :order => 'updated_at.desc' }, feedbacks_client)
+puts "feedbacks count: #{feedbacks.count}"
+puts "feedbacks not by anonymous and superadmin: #{feedbacks.select{|f| f.user_id.present?}.count}"
+

data/gemfiles/Gemfile.activesupport-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'activesupport', '~> 3.2'

data/gemfiles/Gemfile.activesupport-4.0.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'activesupport', '~> 4.0'

data/gemfiles/Gemfile.activesupport-4.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'activesupport', '~> 4.1'

data/gemfiles/Gemfile.activesupport-head

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'activesupport', github: 'rails/rails'

data/lib/dimelo/ccp/api/basic_object.rb

@@ -0,0 +1,17 @@
+module Dimelo::CCP
+  module API
+
+    class BasicObject
+      # http://ruby-doc.org/core-1.9/classes/BasicObject.html
+      # http://sequel.heroku.com/2010/03/31/sequelbasicobject-and-ruby-18/
+      KEEP_METHODS = %w(__id__ __send__ instance_eval == equal? initialize method_missing respond_to?)
+
+      def self.remove_methods!
+        m = (private_instance_methods + instance_methods) - KEEP_METHODS
+        m.each{|m| undef_method(m)}
+      end
+      remove_methods!
+    end if not defined?(BasicObject)
+
+  end
+end

data/lib/dimelo/ccp/api/client.rb

@@ -0,0 +1,46 @@
+module Dimelo::CCP
+  module API
+    class Client
+
+      attr_accessor :base_uri, :default_parameters
+
+      def initialize(base_uri, options={})
+        @base_uri = base_uri.is_a?(URI) ? base_uri : URI.parse(base_uri)
+        options = options.with_indifferent_access
+        @http_options = options.delete(:http_options) || {}
+        @default_parameters = options
+      end
+
+      def check
+        Dimelo::CCP::API.decode_json(transport(:get, 'check'))
+      end
+
+      def config
+        Dimelo::CCP::API.decode_json(transport(:get, 'config'))
+      end
+
+      def transport(method, path, payload={})
+        response = connection.perform(method, path, default_parameters.merge(payload))
+
+        if response.success? or response.status == 422
+          response.body
+        else
+          raise Error.from(method, path, response.status, response.body)
+        end
+      end
+
+      private
+
+      def request_uri(path, params)
+        @base_uri.dup.tap do |uri|
+          uri.path = File.join(uri.path, path).chomp('/')
+        end.request_uri
+      end
+
+      def connection
+        @connection ||= Connection.from_uri(@base_uri, @http_options)
+      end
+
+    end
+  end
+end

data/lib/dimelo/ccp/api/common/openable.rb

@@ -0,0 +1,23 @@
+module Dimelo::CCP
+  module API
+    module Common
+      module Openable
+
+        def open
+          path = "#{compute_path(attributes)}/open"
+          response = client.transport(:put, path)
+          self.attributes = Dimelo::CCP::API.decode_json(response)
+          errors.empty?
+        end
+
+        def close
+          path = "#{compute_path(attributes)}/close"
+          response = client.transport(:put, path)
+          self.attributes = Dimelo::CCP::API.decode_json(response)
+          errors.empty?
+        end
+
+      end
+    end
+  end
+end

data/lib/dimelo/ccp/api/common/publishable.rb

@@ -0,0 +1,23 @@
+module Dimelo::CCP
+  module API
+    module Common
+      module Publishable
+
+        def publish
+          path = "#{compute_path(attributes)}/publish"
+          response = client.transport(:put, path)
+          self.attributes = Dimelo::CCP::API.decode_json(response)
+          errors.empty?
+        end
+
+        def unpublish
+          path = "#{compute_path(attributes)}/unpublish"
+          response = client.transport(:put, path)
+          self.attributes = Dimelo::CCP::API.decode_json(response)
+          errors.empty?
+        end
+
+      end
+    end
+  end
+end

data/lib/dimelo/ccp/api/common/starrable.rb

@@ -0,0 +1,23 @@
+module Dimelo::CCP
+  module API
+    module Common
+      module Starrable
+
+        def star! #use method name with bang to differenciate from #star attribute
+          path = "#{compute_path(attributes)}/star"
+          response = client.transport(:put, path)
+          self.attributes = Dimelo::CCP::API.decode_json(response)
+          errors.empty?
+        end
+
+        def unstar!
+          path = "#{compute_path(attributes)}/unstar"
+          response = client.transport(:put, path)
+          self.attributes = Dimelo::CCP::API.decode_json(response)
+          errors.empty?
+        end
+
+      end
+    end
+  end
+end

data/lib/dimelo/ccp/api/connection.rb

@@ -0,0 +1,86 @@
+require 'net/https'
+
+module Dimelo::CCP
+  module API
+    class Connection
+
+      class << self
+
+        def from_uri(uri, options = {})
+          options.merge!(:use_ssl => uri.scheme == 'https')
+          pool[uri_key(uri)] ||= new(uri.to_s, options)
+        end
+
+        private
+
+        def uri_key(uri)
+          "#{uri.scheme}://#{uri.host}:#{uri.port}"
+        end
+
+        def pool
+          @pool ||= {}
+        end
+
+      end
+
+      def initialize(url, options={})
+        @url = url
+        @http_options = options
+        initialize_client
+      end
+
+      def perform(method, uri, payload={})
+        @client.send(method, uri, payload) do |req|
+          req.headers[:accept] = 'application/json'
+          req.headers[:user_agent] = user_agent
+        end
+      end
+
+      private
+
+      def timeout
+        @http_options[:timeout] || 10
+      end
+
+      def user_agent_details
+        strip_non_ascii(@http_options[:user_agent] || '')
+      end
+
+      def strip_non_ascii(setting, replacement = '')
+        setting.gsub(/\P{ASCII}/, replacement)
+      end
+
+      def user_agent
+        "DimeloAPI/#{Dimelo::CCP::API::VERSION} " \
+          << (user_agent_details.present? ? "(#{user_agent_details}) " : '') \
+          << "Faraday/#{Faraday::VERSION} " \
+          << "Ruby/#{RUBY_VERSION}"
+      end
+
+      def client_options
+        {}.tap do |opts|
+          opts[:request] = request_options
+          opts[:ssl] = ssl_options if @http_options[:use_ssl]
+        end
+      end
+
+      def request_options
+        { timeout: timeout, open_timeout: timeout }
+      end
+
+      def ssl_options
+        { verify_mode: OpenSSL::SSL::VERIFY_NONE, verify_depth: 5 }
+      end
+
+      def initialize_client
+        @client = Faraday.new(@url, client_options) do |faraday|
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter #adapter should be last in the list https://github.com/lostisland/faraday/issues/161
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dimelo/ccp/api/error.rb

@@ -0,0 +1,71 @@
+module Dimelo::CCP
+  module API
+    class Error < StandardError
+      attr_accessor :original_exception
+
+      # Public : Return specific Exceptions if defined
+      #
+      # Returns :
+      # - DefinedError descendant exception (DomainNotFoundError,...) if status & name matches declared DefinedError child
+      # - BaseError if status and name does not match any declared Error
+      # - Error if body cannot be json parsed
+      def self.from(method, path, http_status, body)
+        json = Dimelo::CCP::API.decode_json(body).symbolize_keys!
+        name = json.delete(:error)
+        status = json.delete(:status)
+        message = json.delete(:message)
+
+        if klass = DefinedError.descendants.find { |error| error.status == status && error.name == name}
+          klass.new
+        else
+          BaseError.new(name, status, message)
+        end
+      rescue ActiveSupport::JSON.parse_error
+        new("#{method.to_s.upcase} #{path} - #{http_status} #{body}")
+      end
+    end
+
+    class BaseError < StandardError
+      def initialize(name, status, message='')
+        @name = name
+        @status = status
+        @message = message
+        super("error_type:#{name} - status:#{status} - body:#{message}")
+      end
+    end
+
+    class DefinedError < StandardError
+      class_attribute :status, :name
+    end
+
+    class DomainNotFoundError < DefinedError
+      self.status = 404
+      self.name = 'domain_not_found'
+    end
+
+    class InvalidAccessTokenError < DefinedError
+      self.status = 403
+      self.name = 'invalid_access_token'
+    end
+
+    class InvalidUserTypeError < DefinedError #happens only on POST /users
+      self.status = 400
+      self.name = 'invalid_user_type'
+    end
+
+    class NotEnabledError < DefinedError
+      self.status = 403
+      self.name = 'api_not_enabled'
+    end
+
+    class NotFoundError < DefinedError
+      self.status = 404
+      self.name = 'not_found'
+    end
+
+    class SslError < DefinedError
+      self.status = 412
+      self.name = 'routing_error'
+    end
+  end
+end

data/lib/dimelo/ccp/api/lazzy_collection.rb

@@ -0,0 +1,114 @@
+module Dimelo::CCP
+  module API
+
+    class LazzyCollection < BasicObject
+
+      include ::Enumerable
+
+      class << self
+
+        def new(params, &block)
+          if (params.has_key?(:offset) || params.has_key?('offset'))
+            yield params
+          else
+            instance = super(params, &block)
+            instance.paginator.first.is_a?(Enumerable) ? instance : instance.paginator.first
+          end
+        end
+
+      end
+
+      attr_reader :paginator
+
+      def initialize(params={}, &block)
+        @paginator = Paginator.new(params, &block)
+      end
+
+      def [](index)
+        paginator.get_item_at(index)
+      end
+
+      def to_a
+        @to_a ||= each
+      end
+      alias :to_ary :to_a
+
+      def respond_to?(method)
+        super || Array.public_instance_methods.include?(method.to_s)
+      end
+
+      def each(&block)
+        index = 0
+        while true
+          item = paginator.get_item_at(index)
+          break if item.nil?
+          yield item if block.present?
+          index += 1
+        end
+        paginator.flatten
+      end
+
+      def inspect
+        "<Dimelo::CCP::API::LazzyCollection instance>"
+      end
+
+      protected
+
+      # /!\ Fetch all API, please avoid this behavior
+      def method_missing(name, *args, &block)
+        super unless respond_to?(name)
+        warn %{WARNING: Method '#{name}` called on LazzyCollection object from #{Kernel.caller.first}.
+  All API items might be fetched, so please verify that you are a consenting adult.}
+        self.to_a.send(name, *args, &block)
+      end
+
+      def warn(message)
+        defined?(Rails) ? Rails.logger.warn(message) : STDERR.puts(message)
+      end
+
+      class Paginator
+
+        DEFAULT_PAGE_SIZE = 30
+
+        attr_reader :page_cache
+
+        def initialize(params, &block)
+          @params = params.dup
+          @block = block
+          @page_cache = []
+        end
+
+        def page_size
+          @page_size ||= (@params[:limit] || DEFAULT_PAGE_SIZE).to_i
+        end
+
+        def page_offset(page_index)
+          page_index * page_size
+        end
+
+        def [](index)
+          page_cache[index.to_i] ||= @block.call(params_for_page(index))
+        end
+
+        def params_for_page(index)
+          @params.merge(:offset => page_offset(index.to_i), :limit => page_size)
+        end
+
+        def get_item_at(position)
+          self[position / page_size][position % page_size]
+        end
+
+        def flatten
+          page_cache.flatten(1)
+        end
+
+        def first
+          self[0]
+        end
+
+      end
+
+    end
+
+  end
+end