dimelo_ccp_api 0.4.1

data/spec/lib/dimelo/ccp/api/client_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Dimelo::CCP::API::Client do
+
+  subject do
+    Dimelo::CCP::API::Client.new('https://domain-test.api.users.dimelo.info:4433/1.0', 'access_token' => ENV['DIMELO_API_KEY'], :http_options => {:timeout => 80})
+  end
+
+  def response_error(status, error, message='')
+    double  success?: false,
+            body: %Q{{
+                    "error": "#{error}",
+                    "message": "#{message}",
+                    "status": #{status}
+                  }},
+            status: status
+  end
+
+  describe '#transport' do
+
+    it 'return an the response body' do
+      pending('no api key') unless ENV['DIMELO_API_KEY'].present?
+      json = JSON.parse(subject.transport(:get, 'check'))
+      expect(json).to eq({"success" => true})
+    end
+
+    it 'raise InvalidAccessTokenError if token is invalid' do
+      expect{
+        subject.transport(:get, 'check', {'access_token' => 'invalid'})
+      }.to raise_error(Dimelo::CCP::API::InvalidAccessTokenError)
+    end
+
+    it 'raise NotFoundError if path is invalid' do
+      expect{
+        subject.transport(:get, 'invalid_path', {'access_token' => 'invalid'})
+      }.to raise_error(Dimelo::CCP::API::NotFoundError)
+    end
+
+    it 'raise NotEnabledError if api is not enabled' do
+      allow(subject).to receive_message_chain('connection.perform') { response_error 403, 'api_not_enabled' }
+      expect{
+        subject.transport(:get, 'check', {'access_token' => 'my-token'})
+      }.to raise_error(Dimelo::CCP::API::NotEnabledError)
+    end
+
+    it 'raise SSLError if request should be https' do
+      allow(subject).to receive_message_chain('connection.perform') { response_error 412, 'routing_error' }
+      expect{
+        subject.transport(:get, 'check', {'access_token' => 'my-token'})
+      }.to raise_error(Dimelo::CCP::API::SslError)
+    end
+
+    it 'raise InvalidUserTypeError if create user is invalid' do
+      allow(subject).to receive_message_chain('connection.perform') { response_error 400, 'invalid_user_type' }
+      expect{
+        subject.transport(:post, 'users', {'access_token' => 'my-token'})
+      }.to raise_error(Dimelo::CCP::API::InvalidUserTypeError)
+    end
+
+    it 'raise DomainNotFoundError if request on invalid domain' do
+      client = Dimelo::CCP::API::Client.new('https://no-domain.api.users.dimelo.info:4433/1.0', :http_options => {:timeout => 80})
+      expect{
+        client.transport(:get, 'check', {'access_token' => 'my-token'})
+      }.to raise_error(Dimelo::CCP::API::DomainNotFoundError)
+    end
+
+    it 'raise an API::Error if body is not json' do
+      allow(subject).to receive_message_chain('connection.perform') { double success?: false, body: 'MemCache Error', status: 500 }
+      expect{
+        subject.transport(:post, 'users', {'access_token' => 'my-token'})
+      }.to raise_error(Dimelo::CCP::API::Error, 'POST users - 500 MemCache Error')
+    end
+
+    it 'raise an API::BaseError if error does not match defined errors' do
+      allow(subject).to receive_message_chain('connection.perform') { response_error 123, 'unable_action', 'cannot perform action' }
+      expect{
+        subject.transport(:post, 'users', {'access_token' => 'my-token'})
+      }.to raise_error(Dimelo::CCP::API::BaseError, 'error_type:unable_action - status:123 - body:cannot perform action')
+    end
+
+    it 'return an the response body in case of validation error' do
+      pending('no api key') unless ENV['DIMELO_API_KEY'].present?
+      json = JSON.parse(subject.transport(:post, 'roles', {}))
+      expect(json).to include "error" => 'validation_error'
+      expect(json).to include "errors" => [{"attribute"=>"label", "type"=>"invalid", "message"=>"Label is invalid"}]
+      expect(json).to include "message" => "Role can't be saved"
+      expect(json).to include "status" => 422
+    end
+
+  end
+
+  describe '#default_parameters' do
+    it 'is not polluted by http_options' do
+      expect(subject.default_parameters).not_to include('http_options')
+      expect(subject.default_parameters).not_to include(:http_options)
+    end
+  end
+
+  describe '#connection' do
+
+    it 'returns a Connection' do
+      expect(subject.send(:connection)).to be_kind_of(Dimelo::CCP::API::Connection)
+    end
+
+    it 'supports http_options' do
+      expect(Dimelo::CCP::API::Connection).to receive(:from_uri).with(anything,hash_including(:timeout => 80))
+      subject.send(:connection)
+    end
+  end
+
+end

data/spec/lib/dimelo/ccp/api/connection_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Dimelo::CCP::API::Connection do
+
+  describe '.from_uri' do
+
+    let(:http_uri) { URI.parse('http://example.com:8080/foo/bar?egg=spam')}
+    let(:https_uri) { URI.parse('https://example.com:8080/foo/bar?egg=spam')}
+
+    it 'should infer :use_ssl => true from the scheme' do
+      expect(Dimelo::CCP::API::Connection).to receive(:new).with('https://example.com:8080/foo/bar?egg=spam', :use_ssl => true)
+      Dimelo::CCP::API::Connection.from_uri(https_uri)
+    end
+
+    it 'should infer :use_ssl => false from the scheme' do
+      expect(Dimelo::CCP::API::Connection).to receive(:new).with('http://example.com:8080/foo/bar?egg=spam', :use_ssl => false)
+      Dimelo::CCP::API::Connection.from_uri(http_uri)
+    end
+
+    it 'should support http options' do
+      expect(Dimelo::CCP::API::Connection).to receive(:new).with('http://example.com:8080/foo/bar?egg=spam', :use_ssl => false, :timeout => 80)
+      Dimelo::CCP::API::Connection.from_uri(http_uri, :timeout => 80)
+    end
+
+    it 'should reuse connections for same scheme/hosts/port' do
+      first = Dimelo::CCP::API::Connection.from_uri(http_uri)
+      second = Dimelo::CCP::API::Connection.from_uri(http_uri)
+      expect(first.object_id).to eq(second.object_id)
+    end
+
+  end
+
+  describe '#perform' do
+
+    context 'HTTP' do
+
+      subject do
+        Dimelo::CCP::API::Connection.new('www.google.fr')
+      end
+
+      let(:request) { [:get, 'http://www.google.fr/'] }
+
+      it 'works' do
+        response = subject.perform(*request)
+        expect(response.body).to_not be_empty
+        expect(response).to be_success
+      end
+
+    end
+
+    context 'HTTPS' do
+
+      subject do
+        Dimelo::CCP::API::Connection.new('www.google.fr:443', :use_ssl => true)
+      end
+
+      let(:request) { [:get, 'https://www.google.fr/'] }
+
+      it 'works' do
+        response = subject.perform(*request)
+        expect(response.body).to_not be_empty
+        expect(response).to be_success
+      end
+
+    end
+
+    subject do
+      Dimelo::CCP::API::Connection.new('github.com:443')
+    end
+
+    let(:file) { Faraday::UploadIO.new(File.expand_path('../../../../../fixtures/files/logo.jpg', __FILE__), 'image/jpeg') }
+
+    it 'sends multipart request with attachment' do
+      response = subject.perform(:put, 'http://www.google.com', {:file => file})
+      expect(response.env[:request_headers]["Content-Type"]).to include('multipart/form-data')
+    end
+
+    it 'sends multipart when containing attachment param' do
+      response = subject.perform(:put, 'http://www.google.com', {:file => file, :q => 'hello'})
+      expect(response.env[:request_headers]["Content-Type"]).to include('multipart/form-data')
+    end
+
+    it 'should sends form urlencoded without attachment' do
+      response = subject.perform(:put, 'http://www.google.com', {:q => 'hello'})
+      expect(response.env[:request_headers]["Content-Type"]).to eq('application/x-www-form-urlencoded')
+    end
+
+    it 'sends accept json request' do
+      response = subject.perform(:get, 'http://www.google.com', {:q => 'hello'})
+      expect(response.env[:request_headers][:accept]).to eq('application/json')
+      expect(response).to be_success
+    end
+
+    it 'sends user_agent request' do
+      response = subject.perform(:get, 'http://www.google.com', {:q => 'hello'})
+      expect(response.env[:request_headers][:user_agent]).to eq("DimeloAPI/#{Dimelo::CCP::API::VERSION} Faraday/#{Faraday::VERSION} Ruby/#{RUBY_VERSION}")
+      expect(response).to be_success
+    end
+
+    context 'Custom user_agent with valid ASCII characters' do
+      let!(:custom_user_agent) { "SMCC; I asked and failed" }
+
+      subject do
+        Dimelo::CCP::API::Connection.new('github.com:443', :user_agent => custom_user_agent)
+      end
+
+      it 'sends custom user_agent request' do
+        response = subject.perform(:get, 'http://www.google.com', {:q => 'hello'})
+        expect(response.env[:request_headers][:user_agent]).to eq("DimeloAPI/#{Dimelo::CCP::API::VERSION} (#{custom_user_agent}) Faraday/#{Faraday::VERSION} Ruby/#{RUBY_VERSION}")
+        expect(response).to be_success
+      end
+    end
+
+    context 'Custom user_agent with invalid UTF-8 characters' do
+      let!(:custom_user_agent) { "SMCC; J'ai demandé & j'ai échoué" }
+
+      subject do
+        Dimelo::CCP::API::Connection.new('github.com:443', :user_agent => custom_user_agent)
+      end
+
+      it 'sends custom user_agent request' do
+        response = subject.perform(:get, 'http://www.google.com', {:q => 'hello'})
+        expect(response.env[:request_headers][:user_agent]).to eq("DimeloAPI/#{Dimelo::CCP::API::VERSION} (SMCC; J'ai demand & j'ai chou) Faraday/#{Faraday::VERSION} Ruby/#{RUBY_VERSION}")
+        expect(response).to be_success
+      end
+    end
+  end
+
+end

data/spec/lib/dimelo/ccp/api/model/attachment_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Dimelo::CCP::Attachment do
+  let(:client) { Dimelo::CCP::API::Client.new('https://domain-test.api.answers.dimelo.info/1.0', 'access_token' => 'foo') }
+
+  describe Dimelo::CCP::QuestionAttachment do
+
+    it 'use question path' do
+      expect(client).to receive(:transport).with(:get, 'questions/1/attachments', {:offset=>0, :limit=>30}).and_return('[]')
+      Dimelo::CCP::QuestionAttachment.find({:question_id => 1}, client)
+    end
+
+  end
+
+  describe Dimelo::CCP::AnswerAttachment do
+
+    it 'use answer path' do
+      expect(client).to receive(:transport).with(:get, 'questions/2/answers/1/attachments', {:offset=>0, :limit=>30}).and_return('[]')
+      Dimelo::CCP::AnswerAttachment.find({question_id: 2, answer_id: 1}, client)
+    end
+
+  end
+
+end

data/spec/lib/dimelo/ccp/api/model/feedback_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Dimelo::CCP::Feedback do
+
+  it_behaves_like 'common model actions'
+  it_behaves_like 'starrable object'
+
+end

data/spec/lib/dimelo/ccp/api/model/question_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Dimelo::CCP::Question do
+
+  it_behaves_like 'common model actions'
+  it_behaves_like 'starrable object'
+
+end

data/spec/lib/dimelo/ccp/api/model_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+
+describe Dimelo::CCP::API::Model do
+
+  class User < Dimelo::CCP::API::Model
+    path 'groups/%{group_id}/users/%{id}'
+    attributes :id, :firstname, :lastname
+  end
+
+  class BaseUser < Dimelo::CCP::API::Model
+    attributes :id, :firstname, :lastname
+  end
+
+  describe '.new' do
+
+    it "creates user with given attributes" do
+      user = User.new(:id => 1, :firstname => 'Homer Jay', :lastname => 'Simpson')
+      expect(user.id).to eq(1)
+      expect(user.firstname).to eq('Homer Jay')
+      expect(user.lastname).to eq('Simpson')
+    end
+
+  end
+
+  describe '.parse' do
+
+    it 'parses one json record' do
+      user = User.parse(%[
+          {
+            "id": 1,
+            "firstname": "Homer Jay",
+            "lastname": "Simpson"
+          }
+        ])
+
+      expect(user).to be_a(User)
+      expect(user.id).to eq(1)
+      expect(user.firstname).to eq('Homer Jay')
+      expect(user.lastname).to eq('Simpson')
+    end
+
+    it 'parses many json records' do
+      user = User.parse(%[
+        [
+          {
+            "id": 1,
+            "firstname": "Homer Jay",
+            "lastname": "Simpson"
+          },
+          {
+            "id": 2,
+            "firstname": "Marjorie 'Marge'",
+            "lastname": "Simpson"
+          }
+        ]
+      ])
+
+      expect(user.size).to eq(2)
+      user.each do |u|
+        expect(u).to be_a(User)
+      end
+
+    end
+
+  end
+
+  describe '.path' do
+    let(:user) { BaseUser.new }
+
+    it 'should not have leading and trailling "/" to not override path_prefix' do
+      expect(user.compute_path).to eq('base_users')
+    end
+
+    it 'should work when computed with criteria' do
+      expect(user.compute_path(:id => 1)).to eq('base_users/1')
+    end
+
+  end
+
+  describe '.find' do
+
+    let(:client) { Dimelo::CCP::API::Client.new('https://domain-test.api.users.dimelo.com/1.0', 'access_token' => 'foo') }
+
+    it 'compute index path' do
+      expect(client).to receive(:transport).with(:get, 'groups/42/users', {:offset=>0, :limit=>30}).and_return('[]')
+      User.find({:group_id => 42}, client)
+    end
+
+    it 'compute show path' do
+      expect(client).to receive(:transport).with(:get, 'groups/42/users/1', {:offset=>0, :limit=>30}).and_return('{}')
+      User.find({:group_id => 42, :id => 1}, client)
+    end
+
+    it 'send extra criterias as payload' do
+      expect(client).to receive(:transport).with(:get, 'groups/42/users', {:order => 'foo', :egg => 'spam', :offset=>0, :limit=>30}).and_return('[]')
+      User.find({:group_id => 42, :order => 'foo', :egg => 'spam'}, client)
+    end
+
+    it 'send the result to .parse' do
+      expect(client).to receive(:transport).at_least(1).times.and_return('JSON')
+      expect(User).to receive(:parse).at_least(1).times.with('JSON', client)
+      User.find({:group_id => 42}, client)
+    end
+
+  end
+
+  describe '#tracked_attributes' do
+
+    before :each do
+      class Article < Dimelo::CCP::API::Model
+        attributes :id, :category_ids
+      end
+    end
+
+    after :each do
+      Object.send(:remove_const, 'Article')
+    end
+
+    it 'should returns only mass-assigned attributes' do
+      expect(Article.new(:category_ids => nil).tracked_attributes).to eq([:category_ids])
+    end
+
+    it 'should works on single assigning' do
+      article = Article.new
+      article.category_ids = nil
+      expect(article.tracked_attributes).to eq([:category_ids])
+    end
+
+    it 'should returns nothing if not set' do
+      expect(Article.new.tracked_attributes).to eq([])
+    end
+
+  end
+
+  describe '.submit_attributes' do
+
+    before :each do
+      class Article < Dimelo::CCP::API::Model
+        attributes :id, :category_ids
+        submit_attributes :id, :category_ids
+      end
+    end
+
+    after :each do
+      Object.send(:remove_const, 'Article')
+    end
+
+    it 'does not send param when not sent' do
+      expect(Article.new.submit_attributes).to eq({})
+    end
+
+    it 'sends only param specified' do
+      expect(Article.new(:id => 1).submit_attributes).to eq({:id => 1})
+    end
+
+    it 'sends empty string is precised' do
+      expect(Article.new(:id => 1, :category_ids => nil).submit_attributes).to eq({:id => 1, :category_ids => nil})
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+begin
+  require 'spec/autorun'
+rescue LoadError
+  require 'rspec'
+end
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dimelo_ccp_api')
+Dir[File.dirname(__FILE__) + "/examples/**/*.rb"].sort.each { |f| require f }

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: dimelo_ccp_api
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Jean Boussier
+- Renaud Morvan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rest API client for Dimelo CCP v2 plateform
+email:
+- jean.boussier@dimelo.com
+- nel@w3fu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- dimelo_ccp_api.gemspec
+- examples/dimelo_api_test
+- gemfiles/Gemfile.activesupport-3.2.x
+- gemfiles/Gemfile.activesupport-4.0.x
+- gemfiles/Gemfile.activesupport-4.1.x
+- gemfiles/Gemfile.activesupport-head
+- lib/dimelo/ccp/api.rb
+- lib/dimelo/ccp/api/basic_object.rb
+- lib/dimelo/ccp/api/client.rb
+- lib/dimelo/ccp/api/common/openable.rb
+- lib/dimelo/ccp/api/common/publishable.rb
+- lib/dimelo/ccp/api/common/starrable.rb
+- lib/dimelo/ccp/api/connection.rb
+- lib/dimelo/ccp/api/error.rb
+- lib/dimelo/ccp/api/lazzy_collection.rb
+- lib/dimelo/ccp/api/model.rb
+- lib/dimelo/ccp/api/model/answer.rb
+- lib/dimelo/ccp/api/model/attachment.rb
+- lib/dimelo/ccp/api/model/category.rb
+- lib/dimelo/ccp/api/model/category_group.rb
+- lib/dimelo/ccp/api/model/feedback.rb
+- lib/dimelo/ccp/api/model/feedback_comment.rb
+- lib/dimelo/ccp/api/model/membership.rb
+- lib/dimelo/ccp/api/model/private_message.rb
+- lib/dimelo/ccp/api/model/question.rb
+- lib/dimelo/ccp/api/model/role.rb
+- lib/dimelo/ccp/api/model/user.rb
+- lib/dimelo/ccp/api/model/webhook.rb
+- lib/dimelo/ccp/api/version.rb
+- lib/dimelo_ccp_api.rb
+- spec/examples/openable_examples.rb
+- spec/examples/starrable_example.rb
+- spec/fixtures/files/logo.jpg
+- spec/lib/dimelo/ccp/api/client_spec.rb
+- spec/lib/dimelo/ccp/api/connection_spec.rb
+- spec/lib/dimelo/ccp/api/model/attachment_spec.rb
+- spec/lib/dimelo/ccp/api/model/feedback_spec.rb
+- spec/lib/dimelo/ccp/api/model/question_spec.rb
+- spec/lib/dimelo/ccp/api/model_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: dimelo_ccp_api
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Dimelo CCP v2 API client
+test_files:
+- spec/examples/openable_examples.rb
+- spec/examples/starrable_example.rb
+- spec/fixtures/files/logo.jpg
+- spec/lib/dimelo/ccp/api/client_spec.rb
+- spec/lib/dimelo/ccp/api/connection_spec.rb
+- spec/lib/dimelo/ccp/api/model/attachment_spec.rb
+- spec/lib/dimelo/ccp/api/model/feedback_spec.rb
+- spec/lib/dimelo/ccp/api/model/question_spec.rb
+- spec/lib/dimelo/ccp/api/model_spec.rb
+- spec/spec_helper.rb