conclas 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7751fc99f5429f11198d9d8523ba0573c5c90deb
+  data.tar.gz: 8a6aaa2290a3d95c9c06274d072a1720dde9ce12
+SHA512:
+  metadata.gz: 29e34752937802828779c34d7ff9ef650f40c817c8f19efef4bc44bafc8427ab152420d1640e831e36eb591024147b3f8f2c815412d318909d7beb789477bcf7
+  data.tar.gz: 330251a347d13682e988e285cc974b84a3500e027110932a5302b865fb03ae35105f7c6376cb050a59408536c1d5c552fc6d3fb6054d55b624cfb002c1a8c6f4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.rst

@@ -0,0 +1,41 @@
+============
+conclas
+============
+The conclas is a client written in Ruby to use the service Conclas.
+
+============
+Install
+============
+Conclas Ruby Client can be installed using pip:
+
+.. code:: 
+
+  $ gem install conclas
+
+If you prefer to install manually, you must follow the following steps. First clone the repository client ruby ConClas. This is the `link <http://conclas.com>`_
+. After cloning the repository run the following command:
+
+.. code::
+
+  $ gem build conclas.gemspec
+
+Now that we have prepared the package, we will install it. To do this, run the following command:
+
+.. code::
+
+  $ gem install conclas-<version of gem>.gem
+
+==============
+Running tests
+==============
+To run the tests, run the following command:
+
+.. code::
+
+  $ ruby tests/test_conclas.rb
+
+==============
+Documentation
+==============
+To understand more about the client python ConClas, see our `documentation <http://conclas-platform.cleverapps.io/docs/>`_
+.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "conclas"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/conclas.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conclas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "conclas"
+  spec.version       = ConClas::VERSION
+  spec.authors       = ["ConClas"]
+  spec.email         = ["hello@conclas.com"]
+
+  spec.summary       = "Client Ruby ConClas"
+  spec.description   = "The ConClas is a client written in Ruby to use the service ConClas."
+  spec.homepage      = "http://rubygems.org/gems/conclas"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/conclas.rb

@@ -0,0 +1,12 @@
+require "conclas/utils/json_maker"
+require "conclas/utils/string_helper"
+require "conclas/core/conclas_response"
+require "conclas/core/requester"
+require "conclas/core/exceptions/api_custom_exceptions"
+require "conclas/core/exceptions/client_exceptions"
+
+require "conclas/version"
+require "conclas/api"
+
+module ConClas
+end

data/lib/conclas/api.rb

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+require 'conclas/core/requester'
+require 'conclas/core/exceptions/client_exceptions'
+require 'conclas/core/conclas_response'
+require 'conclas/utils/json_maker'
+require 'conclas/utils/string_helper'
+require 'json'
+
+BASE_URL = "http://api.conclas.com/v1"
+METHODS = {
+  :direct => "/classify/direct/",
+  :indirect => "/classify/indirect/"
+}
+
+module ConClas
+  #module to abstract request
+  class Api
+    #include methods of class Request
+    include Core::Requester
+
+    def initialize(token, timeout=60, use_ssl=false)
+      @timeout = timeout
+      if Utils::StringHelper.is_empty token
+        raise EmptyParameterException, "The parameter 'token' needs a value"
+      end
+      @token = token
+      @use_ssl = use_ssl
+      @status_code = nil
+      @headers = nil
+      @response = nil
+      @req = nil
+    end
+
+    #properties
+    def status_code
+      @status_code
+    end
+
+    def headers
+      @headers
+    end
+
+    def response
+      @response
+    end
+
+    #private methods
+    def make_request(url, data)
+      headers = {"Content-Type" => "application/json",
+                  "Authorization" => @token}
+      @req = Core::Requester.post(url, data, headers, @timeout, @use_ssl)
+
+      response = Core::ConClasResponse.new(
+        @req.body, 
+        @req.code, 
+        @req.header.to_hash.inspect)
+
+      if response.request_successful?
+        if check_request
+          populate_properties
+        end
+      end
+    end
+
+    def check_request
+      if @req.code.to_i.between?(400, 499)
+        raise Exceptions::HTTPError, "Client Error #{@req.code}(#{@req.message})."
+      elsif @req.code.to_i.between?(500, 600)
+        raise Exceptions::HTTPError, "Server Error #{@req.code}(#{@req.message})."
+      else
+        true
+      end
+    end
+
+    def populate_properties
+      @status_code = @req.code
+      @headers = @req.header.to_hash.inspect
+      @response = JSON.parse(@req.body, :quirks_mode => true)
+    end
+
+    def check_api_args_method(contents, start_from_category=nil, callback=nil)
+      if contents.length == 0 || !contents.is_a?(Array)
+        raise InvalidParameterException, "The parameter 'contents' needs a value"
+      end
+      
+      if contents.length > 1000
+        raise DocMaxException, "The content size exceeded the limit."
+      end
+      #if !start_from_category.nil?
+      #  if Utils::StringHelper.is_empty start_from_category
+      #    raise Exceptions::InvalidParameterException, "The parameter 'start_from_category' needs a value"
+      #  end
+      #end
+
+      if !callback.nil?
+        if Utils::StringHelper.is_empty callback
+          raise Exceptions::InvalidParameterException, "The parameter 'callback' needs a value"
+        end
+      end
+    end
+
+    private :populate_properties, :check_api_args_method, :make_request
+
+
+    #main methods
+    def direct_classify(contents)
+      check_api_args_method(contents)
+      hashe_data = {:contents => contents}
+      #if !start_from_category.nil?
+      #  hashe_data[:start_from_category] = start_from_category
+      #end
+      json_body_request = Utils::JsonMaker.new(hashe_data).get_json
+      url = BASE_URL + METHODS[:direct]
+      make_request(url, json_body_request)
+    end
+    
+    def indirect_classify(contents, callback)
+      check_api_args_method(contents, callback)
+      hashe_data = {:contents => contents, :callback => callback}
+      #if !start_from_category.nil?
+      #  hashe_data[:start_from_category] = start_from_category
+      #end
+      json_body_request = Utils::JsonMaker.new(hashe_data).get_json
+      url = BASE_URL + METHODS[:indirect]
+      make_request(url, json_body_request)
+    end
+  end
+end

data/lib/conclas/core/conclas_response.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+require 'conclas/core/exceptions/api_custom_exceptions'
+require 'json'
+
+
+module ConClas
+  module Core
+    class ConClasResponse
+      def initialize(result, status_code, headers)
+        @result = JSON.parse(result, :quirks_mode => true)
+        @status_code = status_code
+        @headers = headers
+      end
+
+      def raise_exception(error)
+        code = error["code"].to_i
+        
+        case code
+        when 2
+          raise Exceptions::PaymentRequiredException, error["message"]
+        when 3
+          raise Exceptions::BannedAccountException, error["message"]
+        when 4
+          raise Exceptions::AccountExceedFreeLimitException, error["message"]
+        when 10
+          raise Exceptions::MissingTokenException, error["message"]
+        when 11
+          raise Exceptions::InvalidTokenException, error["message"]
+        when 12
+          raise Exceptions::IncorrectCredentialsException, error["message"]
+        when 13
+          raise Exceptions::InvalidModeException, error["message"]
+        when 14
+          raise Exceptions::InvalidBodyMessageException, error["message"]
+        when 15
+          raise Exceptions::InvalidBodyFormatException, error["message"]
+        when 16
+          raise Exceptions::ApiLimitationException, error["message"]
+        when 30
+          raise Exceptions::LCoreUnsupportedLanguageException, error["message"]
+        when 31
+          raise Exceptions::LCoreInternalException, error["message"]
+        when 32
+          raise Exceptions::ContentTimeoutException, error["message"]
+        else
+          raise "Error not categorized"
+        end
+      end
+
+      private :raise_exception
+
+      def request_successful?
+        if @result.key?("errors")
+          error = @result["errors"][0]
+          raise_exception(error)
+        end
+        true
+      end
+    end
+  end
+end

data/lib/conclas/core/exceptions/api_custom_exceptions.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+module ConClas
+  module Exceptions
+    class InvalidTokenException < StandardError; end
+
+    class IncorrectCredentialsException < StandardError; end
+
+    class MissingTokenException < StandardError; end
+
+    class InvalidBodyFormatException < StandardError; end
+
+    class InvalidBodyMessageException < StandardError; end
+
+    class InvalidModeException < StandardError; end
+
+    class ApiLimitationException < StandardError; end
+
+    class PaymentRequiredException < StandardError; end
+
+    class BannedAccountException < StandardError; end
+
+    class AccountExceedFreeLimitException < StandardError; end
+
+    class LCoreUnsupportedLanguageException < StandardError; end
+
+    class LCoreInternalException < StandardError; end
+
+    class ContentTimeoutException < StandardError; end
+  end
+end

data/lib/conclas/core/exceptions/client_exceptions.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+module ConClas
+  module Exceptions
+    class InvalidParameterException < StandardError; end
+
+    class JsonKeysException < StandardError; end
+
+    class ContentsKeyException < StandardError; end
+
+    class EmptyParameterException < StandardError; end
+
+    class DocMinException < StandardError; end
+
+    class DocMaxException < StandardError; end
+
+    class ParameterTypeError < StandardError; end
+
+    class URLInvalidException < StandardError; end
+
+    class HTTPError < StandardError; end
+  end
+end

data/lib/conclas/core/requester.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module ConClas
+  module Core
+  # class to make requester to server
+    module Requester
+      def self.post(url, data, headers, timeout, use_ssl)
+        begin
+          uri = URI.parse(url) # parse url data(port and host)
+
+          http = Net::HTTP.new(uri.host, uri.port) #create http object with uri data
+          http.use_ssl = use_ssl
+          http.read_timeout = timeout
+          request = Net::HTTP::Post.new(uri.request_uri, initheader = headers)
+          request.body = data
+          http.request(request)
+        rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+              Net::HTTPBadResponse, Net::ReadTimeout, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/conclas/utils/json_maker.rb

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+require 'json'
+require 'conclas/core/exceptions/client_exceptions'
+
+module ConClas
+
+  module Utils
+    REGEX = /(^(https?:\/\/(?:www\.|(?!www)))[\w-]+\.[\w]+)/
+
+    class JsonMaker
+      def initialize(hash_data)
+          @data = hash_data
+      end
+
+      #private methods
+      def validate_key_doc(key_doc)
+        # Validate key "doc"
+        key_doc.each do |key, value|
+          if key != "short_text" && key != "long_text" && key != "brands"
+            raise Exceptions::ContentsKeyException, 'Invalid key "doc".'
+          end
+          if StringHelper.is_empty value
+            raise Exceptions::EmptyParameterException, "The parameter '#{value}' needs a value"
+          end
+        end
+
+        if key_doc.key?("short_text") && key_doc.key?("long_text")
+          doc_len = key_doc["short_text"].length + key_doc["long_text"].length
+          if doc_len < 25
+            raise Exceptions::DocMinException, "The doc is not valid."
+          end
+        end
+        # check short_text
+        if key_doc.key?("short_text")
+          if key_doc["short_text"].length > 1000
+            raise Exceptions::DocMaxException, "The short_text doc is not valid."
+          end
+        end
+        #check long_text
+        if key_doc.key?("long_text")
+          if key_doc["long_text"].length > 20_000
+            raise Exceptions::DocMaxException, "The long_text doc is not valid."
+          end
+        end
+
+        if key_doc.key?("brands")
+          if key_doc["long_text"].length > 5000
+            raise Exceptions::DocMaxException, "The brands doc is not valid."
+          end
+        end
+      end
+
+      def validate_contents
+        # Method to validate contents node
+        @data[:contents].each do |item|
+          if !item.key?("url") && !item.key?("doc")
+            raise Exceptions::ContentsKeyException, "The contents is not valid."
+          end
+          if item.key?("url") && item.key?("doc")
+            raise Exceptions::ContentsKeyException, "There can be the key doc in url in the same hash"
+          end
+
+          if item.key?("url")
+            if StringHelper.is_empty item["url"]
+              raise Exceptions::EmptyParameterException, "The parameter 'url' needs a value"
+            end
+            if not item["url"].is_a?(String)
+              raise Exceptions::ParameterTypeError, "Url must be type string"
+            end
+          end
+
+          if item.key?("doc")
+            if item["doc"].size == 0
+              raise Exceptions::ContentsKeyException, "Key contents invalid"
+            else
+              validate_key_doc(item["doc"])
+            end
+          end
+        end
+      end
+
+      def check_urls
+        # check urls match with regex
+        if @data.key?(:callback)
+          if REGEX =~ @data["callback"] then
+            raise Exceptions::URLInvalidException, "Invalid url callback"
+          end
+        end
+
+        @data[:contents].each do |item|
+          if item.key?("url")
+            if not REGEX =~ item["url"]
+              url = item["url"]
+              raise Exceptions::URLInvalidException, "Invalid url #{url}"
+            end
+          end
+        end
+      end
+
+      private :validate_contents, :validate_key_doc, :check_urls
+
+      def get_json
+        validate_contents
+        check_urls
+        @data.to_json
+      end
+    end
+  end
+end

data/lib/conclas/utils/string_helper.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+require 'json'
+
+module ConClas
+  module Utils
+    class StringHelper
+      def self.is_empty(str)
+        if str.nil? and str.strip.empty? ? true : false
+        end
+      end
+    end
+  end
+end

data/lib/conclas/version.rb

@@ -0,0 +1,3 @@
+module ConClas
+  VERSION = "0.1.1"
+end

data/test.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conclas'
+
+puts ConClas::VERSION

data/tests/test_conclas.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'conclas'
+require 'test/unit'
+
+
+TOKEN = 'API_KEY'
+
+class TestConClas < Test::Unit::TestCase
+  def test_direct_classify
+    api = ConClas::Api.new(TOKEN)
+    contents = [
+      {
+        "url" => "http://techcrunch.com/2016/05/23/we-need-more-driverless-car-accidents/"
+      }
+    ]
+    test_result = [{"language"=>"en", "categories"=>[["Law & Government", 0.007575757575757573]]}]
+    api.direct_classify(contents)
+    assert_equal(test_result, api.response["results"])
+  end
+
+  def test_indirect_classify
+    api = ConClas::Api.new(TOKEN)
+    contents = [
+      {
+        "url" => "http://techcrunch.com/2016/05/23/we-need-more-driverless-car-accidents/"
+      }
+    ]
+    api.indirect_classify(contents, "http://www.mysite.com/callback")
+    assert_equal(true, api.response.key?("ids"))
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: conclas
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ConClas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: The ConClas is a client written in Ruby to use the service ConClas.
+email:
+- hello@conclas.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.rst
+- Rakefile
+- bin/console
+- bin/setup
+- conclas.gemspec
+- lib/conclas.rb
+- lib/conclas/api.rb
+- lib/conclas/core/conclas_response.rb
+- lib/conclas/core/exceptions/api_custom_exceptions.rb
+- lib/conclas/core/exceptions/client_exceptions.rb
+- lib/conclas/core/requester.rb
+- lib/conclas/utils/json_maker.rb
+- lib/conclas/utils/string_helper.rb
+- lib/conclas/version.rb
+- test.rb
+- tests/test_conclas.rb
+homepage: http://rubygems.org/gems/conclas
+licenses:
+- MIT
+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: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Client Ruby ConClas
+test_files: []