dimelo_ccp_api 0.4.1

data/lib/dimelo/ccp/api/model/answer.rb

@@ -0,0 +1,39 @@
+module Dimelo::CCP
+  class Answer < Dimelo::CCP::API::Model
+    include ::Dimelo::CCP::API::Common::Publishable
+
+    path 'questions/%{question_id}/answers/%{id}'
+
+    attributes  :id, :body, :body_format, :flow_state, :user_id, :permalink,
+                :attachments_count, :comments_count,
+                :created_at, :updated_at, :question_id, :ipaddr, :question_flow_state
+
+    submit_attributes :body, :body_format, :user_id, :question_id
+
+    belongs_to :user
+    belongs_to :question
+
+    has_many :answer_attachments
+
+    def admin_stamp
+      path = "#{compute_path(attributes)}/admin_stamp"
+      response = client.transport(:post, path)
+      self.attributes = Dimelo::CCP::API.decode_json(response)
+      errors.empty?
+    end
+
+    def author_stamp
+      path = "#{compute_path(attributes)}/author_stamp"
+      response = client.transport(:post, path)
+      self.attributes = Dimelo::CCP::API.decode_json(response)
+      errors.empty?
+    end
+
+    def unstamp
+      path = "#{compute_path(attributes)}/stamp"
+      response = client.transport(:delete, path)
+      self.attributes = Dimelo::CCP::API.decode_json(response)
+      errors.empty?
+    end
+  end
+end

data/lib/dimelo/ccp/api/model/attachment.rb

@@ -0,0 +1,44 @@
+module Dimelo::CCP
+  class Attachment < Dimelo::CCP::API::Model
+    attributes :id, :file, :original, :question_id
+  end
+
+  class AnswerAttachment < Attachment
+    path 'questions/%{question_id}/answers/%{answer_id}/attachments/%{id}'
+
+    attributes :id, :file, :original, :answer_id, :question_id
+
+    belongs_to :answer
+
+    submit_attributes :file, :question_id, :answer_id
+  end
+
+  class FeedbackCommentAttachment < Attachment
+    path 'feedbacks/%{feedback_id}/comments/%{comment_id}/attachments/%{id}'
+
+    attributes :id, :file, :original, :feedback_id, :comment_id
+    belongs_to :feedback_comment
+
+    submit_attributes :file, :question_id, :answer_id
+  end
+
+  class QuestionAttachment < Attachment
+    path 'questions/%{question_id}/attachments/%{id}'
+
+    attributes :id, :file, :original, :question_id
+
+    belongs_to :question
+
+    submit_attributes :file, :question_id
+  end
+
+  class FeedbackAttachment < Attachment
+    path 'feedbacks/%{feedback_id}/attachments/%{id}'
+
+    attributes :id, :file, :original, :feedback_id
+
+    belongs_to :question
+
+    submit_attributes :file, :feedback_id
+  end
+end

data/lib/dimelo/ccp/api/model/category.rb

@@ -0,0 +1,12 @@
+module Dimelo::CCP
+  class Category < Dimelo::CCP::API::Model
+    path 'category_groups/%{category_group_id}/categories/%{id}'
+
+    attributes :id, :category_group_id, :name, :description, :questions_count, :permalink, :picture
+    alias :to_s :name
+
+    belongs_to :category_group
+    has_many :questions
+
+  end
+end

data/lib/dimelo/ccp/api/model/category_group.rb

@@ -0,0 +1,12 @@
+module Dimelo::CCP
+  class CategoryGroup < Dimelo::CCP::API::Model
+
+    attributes :id, :name, :item_name, :multiple, :optional
+
+    alias_method :multiple?, :multiple
+    alias_method :optional?, :optional
+
+    has_many :categories
+
+  end
+end

data/lib/dimelo/ccp/api/model/feedback.rb

@@ -0,0 +1,20 @@
+module Dimelo::CCP
+  class Feedback < Dimelo::CCP::API::Model
+    include ::Dimelo::CCP::API::Common::Openable
+    include ::Dimelo::CCP::API::Common::Publishable
+    include ::Dimelo::CCP::API::Common::Starrable
+
+    attributes :id, :title, :body, :body_format, :flow_state, :score, :user_id,
+               :category_id, :category_ids, :category_names, :status_id, :star, :starred_at,
+               :closed, :attachments_count, :comments_count, :positive_votes_count, :negative_votes_count,
+               :permalink, :ipaddr, :created_at, :updated_at
+
+    submit_attributes :title, :body, :body_format, :category_ids, :user_id
+
+    belongs_to :user
+    belongs_to :category
+    has_many :feedback_comments
+    alias :comments :feedback_comments
+
+  end
+end

data/lib/dimelo/ccp/api/model/feedback_comment.rb

@@ -0,0 +1,31 @@
+module Dimelo::CCP
+  class FeedbackComment < Dimelo::CCP::API::Model
+    include ::Dimelo::CCP::API::Common::Publishable
+
+    STATUS_COMMENT_PATH = 'feedbacks/%{feedback_id}/status_comments/%{id}'
+    COMMENT_PATH = 'feedbacks/%{feedback_id}/comments/%{id}'
+
+    path COMMENT_PATH
+
+    attributes :id, :feedback_id, :body, :body_format, :flow_state, :user_id, :type, :status_id, :attachments_count, :created_at, :updated_at, :permalink, :ipaddr
+    submit_attributes :body, :body_format, :user_id, :feedback_id, :status_id
+
+    belongs_to :user
+    belongs_to :feedback
+
+    def create
+      self.class.path(STATUS_COMMENT_PATH) if status_id
+      super
+    ensure
+      self.class.path(COMMENT_PATH) if status_id
+    end
+
+    def update
+      self.class.path(STATUS_COMMENT_PATH) if status_id
+      super
+    ensure
+      self.class.path(COMMENT_PATH) if status_id
+    end
+
+  end
+end

data/lib/dimelo/ccp/api/model/membership.rb

@@ -0,0 +1,12 @@
+module Dimelo::CCP
+  class Membership < Dimelo::CCP::API::Model
+
+    path 'users/%{user_id}/memberships/%{id}'
+
+    attributes :id, :user_id, :role, :domain, :domain_application_id
+    submit_attributes :user_id, :role, :domain
+
+    belongs_to :user
+
+  end
+end

data/lib/dimelo/ccp/api/model/private_message.rb

@@ -0,0 +1,8 @@
+module Dimelo::CCP
+  class PrivateMessage < Dimelo::CCP::API::Model
+
+    attributes :id, :title, :body, :html_body, :raw_body, :from_user_id, :to_user_id, :parent_id, :root_id, :created_at, :updated_at
+    submit_attributes :title, :body, :from_user_id, :to_user_id, :parent_id
+
+  end
+end

data/lib/dimelo/ccp/api/model/question.rb

@@ -0,0 +1,20 @@
+module Dimelo::CCP
+  class Question < Dimelo::CCP::API::Model
+    include ::Dimelo::CCP::API::Common::Openable
+    include ::Dimelo::CCP::API::Common::Publishable
+    include ::Dimelo::CCP::API::Common::Starrable
+
+    attributes :id, :title, :body, :body_format, :flow_state, :score, :user_id,
+               :ipaddr, :category_id, :category_ids, :category_names, :starred_at,
+               :answers_count, :attachments_count, :usefulnesses_yes_count, :usefulnesses_no_count,
+               :star, :closed, :permalink, :created_at, :updated_at
+
+    submit_attributes :title, :body, :body_format, :category_ids, :user_id
+
+    belongs_to :user
+    belongs_to :category
+    has_many :answers
+    has_many :question_attachments
+
+  end
+end

data/lib/dimelo/ccp/api/model/role.rb

@@ -0,0 +1,8 @@
+module Dimelo::CCP
+  class Role < Dimelo::CCP::API::Model
+
+    attributes :id, :label, :team
+    attributes :view_site, :edit_customization, :view_admin, :edit_grids, :send_private_message, :view_analytics, :view_identities, :view_advanced_admin, :configure_extensions, :configure_mobile
+
+  end
+end

data/lib/dimelo/ccp/api/model/user.rb

@@ -0,0 +1,37 @@
+module Dimelo::CCP
+  class User < Dimelo::CCP::API::Model
+    CUSTOM_FIELD_COUNT = 10
+    CUSTOM_FIELD_ATTRIBUTES = (1..CUSTOM_FIELD_COUNT).map { |i| "custom_field_#{i}".to_sym }.freeze
+
+    attributes :id, :firstname, :lastname, :signature, :email, :private_message, :type, :username, :flow_state, :about, :avatar, :created_at, :updated_at, :blocked, :team
+    attributes *CUSTOM_FIELD_ATTRIBUTES
+
+    submit_attributes :type, :firstname, :lastname, :email, :username, :avatar_url, :about
+
+    has_many :memberships
+    has_many :questions
+    has_many :answers
+    has_many :feedbacks
+
+    def avatar_url(size='normal')
+      avatar.try(:[], size).try(:[], 'url')
+    end
+
+    # Blocks the specified user
+    def block
+      path = "#{compute_path(attributes)}/block"
+      response = client.transport(:post, path)
+      self.attributes = Dimelo::CCP::API.decode_json(response)
+      errors.empty?
+    end
+
+    # Unblocks the specified user
+    def unblock
+      path = "#{compute_path(attributes)}/unblock"
+      response = client.transport(:post, path)
+      self.attributes = Dimelo::CCP::API.decode_json(response)
+      errors.empty?
+    end
+
+  end
+end

data/lib/dimelo/ccp/api/model/webhook.rb

@@ -0,0 +1,9 @@
+module Dimelo::CCP
+  class Webhook < Dimelo::CCP::API::Model
+
+    attributes :id, :endpoint_enabled, :endpoint_url, :preprod_settings, :verify_token
+    attributes :answer__destroyed, :question__destroyed, :identity__destroyed, :comment__destroyed, :feedback__destroyed, :status_comment__destroyed
+
+    submit_attributes :id, :endpoint_enabled, :endpoint_url, :preprod_settings, :verify_token, :answer__destroyed, :question__destroyed, :identity__destroyed, :comment__destroyed, :feedback__destroyed, :status_comment__destroyed
+  end
+end

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

@@ -0,0 +1,209 @@
+require 'active_model'
+
+module Dimelo::CCP
+  module API
+    class Model
+      extend ActiveModel::Translation
+      extend ActiveModel::Naming
+      include ActiveModel::Validations
+
+      class << self
+
+        def path(*args)
+          @path = args.first if args.any?
+          @path ||= "#{name.demodulize.pluralize.underscore}/%{id}"
+        end
+
+        def attribute(arg)
+          @attributes ||= []
+          @attributes << arg
+          attr_reader(arg)
+          class_eval "
+          def #{arg}=(val)
+            @tracked_attributes << :#{arg}
+            @#{arg} = val
+          end"
+        end
+
+        def attributes(*args)
+          args.each do |arg|
+            attribute arg
+          end
+          @attributes
+        end
+
+        def submit_attributes(*args)
+          @submit_attributes = args if args.any?
+          @submit_attributes ||= []
+        end
+
+        def has_many(association, options={})
+          foreign_class = options[:class_name] || "#{name.gsub(/(\w+)$/, '')}#{association.to_s.singularize.camelize}"
+          foreign_reference = self.name.demodulize.underscore
+          foreign_key = "#{foreign_reference}_id"
+
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+
+            def #{association}(client=nil)
+              # FIXME: clear cache if client change, or something like that
+              client ||= @client
+              @#{association} ||= #{foreign_class}.find({:#{foreign_key} => self.id}, client).each do |instance|
+                instance.#{foreign_reference} = self
+              end
+            end
+
+            def #{association}=(items)
+              @#{association} = items.each{ |i| i.#{foreign_reference} = self }
+            end
+
+          EOS
+
+        end
+
+        def belongs_to(association, options={})
+          attr_writer association
+          foreign_class = options[:class_name] || "#{name.gsub(/(\w+)$/, '')}#{association.to_s.camelize}"
+          foreign_reference = self.name.demodulize.underscore
+          foreign_key = "#{association}_id"
+
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+
+            def #{association}(client=nil)
+              client ||= @client
+              @#{association} ||= #{foreign_class}.find(self.#{foreign_key}, client)
+            end
+
+          EOS
+        end
+
+        def find(*args)
+          client = args.pop
+          criterias = args.pop
+          criterias = {:id => criterias} unless criterias.is_a?(Hash)
+          Dimelo::CCP::API::LazzyCollection.new(criterias) do |criterias|
+            parse(client.transport(:get, compute_path(criterias), criterias), client)
+          end
+        end
+
+        def parse(document, client=nil)
+          object = Dimelo::CCP::API.decode_json(document)
+          object.is_a?(Array) ? object.map{ |i| new(i, client) } : new(object, client)
+        end
+
+        # Inspired by https://github.com/svenfuchs/i18n/blob/master/lib/i18n/core_ext/string/interpolate.rb
+        INTERPOLATION_PATTERN = /%\{(\w+)\}/ # matches placeholders like "%{foo}"
+        def compute_path(criterias={})
+          path.gsub(INTERPOLATION_PATTERN) do |match|
+            criterias.delete($1.to_sym) || ''
+          end.chomp '/'
+        end
+
+      end
+
+      attr_accessor :client
+      attr_reader :errors, :tracked_attributes
+
+      delegate :compute_path, :to => 'self.class'
+
+      def initialize(hash={}, client=nil)
+        @errors = ActiveModel::Errors.new(self)
+        @tracked_attributes = []
+        self.client = client
+        hash.each do |k,v|
+          self.send("#{k}=", v) if self.respond_to?("#{k}=")
+        end
+      end
+
+      def errors=(errs)
+        @errors = ActiveModel::Errors.new(self).tap do |errors|
+          errs.each do |error|
+            errors.add(error['attribute'], error['type'])
+          end
+        end
+      end
+
+      def attributes
+        Hash[self.class.attributes.map{ |key| [key, self.send(key)] }]
+      end
+
+      def attributes=(hash)
+        hash.each do |k, value|
+          if self.respond_to? "#{k}="
+            self.send("#{k}=", value)
+          else
+            warn("Unknown field or method #{k} for object #{self.inspect}")
+          end
+        end
+      end
+
+      def tracked_submit_attributes
+        @tracked_attributes & self.class.submit_attributes
+      end
+
+      def submit_attributes
+        Hash[tracked_submit_attributes.map{ |key| [key, self.send(key)] }]
+      end
+
+      def new_record?
+        id.blank?
+      end
+
+      def save
+        if new_record?
+          create
+        else
+          update
+        end
+      end
+
+      def create
+        attrs = submit_attributes
+        path = compute_path(attrs)
+        response = client.transport(:post, path, attrs)
+        self.attributes = Dimelo::CCP::API.decode_json(response)
+        id.present?
+      end
+
+      def update
+        attrs = submit_attributes
+        path = compute_path(attributes)
+        response = client.transport(:put, path, attrs)
+        self.attributes = Dimelo::CCP::API.decode_json(response)
+        errors.empty?
+      end
+
+      def valid?
+        true
+      end
+
+      def destroy
+        client.transport(:delete, compute_path(self.attributes))
+        freeze
+      end
+
+      def reload
+        raise ArgumentError.new("You cannot fetch models without a populated id attribute") if id.nil?
+        other = self.class.find(id, client)
+        self.attributes.merge!(other.attributes) if other
+        self
+      end
+
+      def ==(other)
+        other.is_a?(self.class) and self.id == other.id and self.id.present?
+      end
+
+      def merge!(other)
+        self.attributes = other.attributes
+      end
+
+      def to_json
+        Dimelo::CCP::API.encode_json(self.attributes)
+      end
+
+      def warn(message)
+        defined?(Rails) ? Rails.logger.warn(message) : STDERR.puts(message)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Dimelo
+  module CCP
+    module API
+      VERSION = File.read(File.join(File.dirname(__FILE__),'..', '..', '..', '..','VERSION') ).strip
+    end
+  end
+end

data/lib/dimelo/ccp/api.rb

@@ -0,0 +1,62 @@
+require 'active_support'
+require 'active_support/json'
+require 'active_support/core_ext'
+require 'faraday'
+require 'uri'
+
+module Dimelo
+  module CCP
+
+    autoload :Answer,         'dimelo/ccp/api/model/answer'
+    autoload :Attachment,     'dimelo/ccp/api/model/attachment'
+    autoload :Category,       'dimelo/ccp/api/model/category'
+    autoload :CategoryGroup,  'dimelo/ccp/api/model/category_group'
+    autoload :Feedback,       'dimelo/ccp/api/model/feedback'
+    autoload :FeedbackComment,'dimelo/ccp/api/model/feedback_comment'
+    autoload :Membership,     'dimelo/ccp/api/model/membership'
+    autoload :PrivateMessage, 'dimelo/ccp/api/model/private_message'
+    autoload :Question,       'dimelo/ccp/api/model/question'
+    autoload :Role,           'dimelo/ccp/api/model/role'
+    autoload :User,           'dimelo/ccp/api/model/user'
+    autoload :Webhook,           'dimelo/ccp/api/model/webhook'
+
+    # Attachments
+    autoload :AnswerAttachment,           'dimelo/ccp/api/model/attachment'
+    autoload :CommentAttachment,          'dimelo/ccp/api/model/attachment'
+    autoload :FeedbackAttachment,         'dimelo/ccp/api/model/attachment'
+    autoload :FeedbackCommentAttachment,  'dimelo/ccp/api/model/attachment'
+    autoload :QuestionAttachment,         'dimelo/ccp/api/model/attachment'
+
+    module API
+
+      autoload :VERSION,          'dimelo/ccp/api/version'
+      autoload :Client,           'dimelo/ccp/api/client'
+      autoload :Connection,       'dimelo/ccp/api/connection'
+      autoload :Model,            'dimelo/ccp/api/model'
+      autoload :BasicObject,      'dimelo/ccp/api/basic_object'
+      autoload :LazzyCollection,  'dimelo/ccp/api/lazzy_collection'
+
+      require 'dimelo/ccp/api/error'
+
+      class << self
+
+        def decode_json(document)
+          ActiveSupport::JSON.decode(document)
+        end
+
+        def encode_json(object)
+          ActiveSupport::JSON.encode(object)
+        end
+
+      end
+
+      module Common
+
+        autoload :Openable, 'dimelo/ccp/api/common/openable'
+        autoload :Publishable, 'dimelo/ccp/api/common/publishable'
+        autoload :Starrable, 'dimelo/ccp/api/common/starrable'
+
+      end
+    end
+  end
+end

data/lib/dimelo_ccp_api.rb

@@ -0,0 +1 @@
+require 'dimelo/ccp/api'

data/spec/examples/openable_examples.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+shared_examples_for 'common model actions' do
+
+  before :each do
+    @response = {'title' => 'new title'}.to_json
+    @client = double
+    allow(@client).to receive(:transport) { @response }
+    @content = described_class.new({'id' => 123, 'title' => 'old title'}, @client)
+    allow(@content).to receive(:errors) { [] }
+  end
+
+  %w(open close publish unpublish).each do |action|
+    describe action do
+
+      it 'sends a put to the appropriate uri' do
+        path = @content.compute_path(@content.attributes) + "/#{action}"
+        expect(@client).to receive(:transport).with(:put, path).and_return(@response)
+        @content.send(action)
+      end
+
+      it 'updates the object with the new attributes' do
+        expect {
+          @content.send(action)
+        }.to change { @content.title }.from('old title').to('new title')
+      end
+
+      it 'returns a boolean indicating any errors' do
+        expect {
+          allow(@content).to receive(:errors) { ['uh-oh'] }
+        }.to change { @content.send(action) }.from(true).to(false)
+      end
+
+    end
+  end
+
+end

data/spec/examples/starrable_example.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+shared_examples_for 'starrable object' do
+
+  before :each do
+    @response = {'title' => 'new title'}.to_json
+    @client = double
+    allow(@client).to receive(:transport) { @response }
+    @content = described_class.new({'id' => 123, 'title' => 'old title'}, @client)
+    allow(@content).to receive(:errors) { [] }
+  end
+
+  describe '#star!' do
+
+    it 'sends a put to the appropriate uri' do
+      path = @content.compute_path(@content.attributes) + "/star"
+      expect(@client).to receive(:transport).with(:put, path).and_return(@response)
+      @content.star!
+    end
+
+    it 'updates the object with the new attributes' do
+      expect {
+        @content.star!
+      }.to change { @content.title }.from('old title').to('new title')
+    end
+
+    it 'returns a boolean indicating any errors' do
+      expect {
+        allow(@content).to receive(:errors) { ['uh-oh'] }
+      }.to change { @content.star! }.from(true).to(false)
+    end
+
+  end
+
+  describe '#unstar!' do
+
+    it 'sends a put to the appropriate uri' do
+      path = @content.compute_path(@content.attributes) + "/unstar"
+      expect(@client).to receive(:transport).with(:put, path).and_return(@response)
+      @content.unstar!
+    end
+
+    it 'updates the object with the new attributes' do
+      expect {
+        @content.unstar!
+      }.to change { @content.title }.from('old title').to('new title')
+    end
+
+    it 'returns a boolean indicating any errors' do
+      expect {
+        allow(@content).to receive(:errors) { ['uh-oh'] }
+      }.to change { @content.unstar! }.from(true).to(false)
+    end
+
+  end
+
+end