dandelionapi 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e24257bbcc32e368db80064ce40f9ddd15c2c6a8
-  data.tar.gz: bc758810bdfb49dbb0767b5f2018e13730ca234d
+  metadata.gz: a48b39d9bb3f7624ba350f7c0bd0edbeafeda0df
+  data.tar.gz: 7999d50dcae26f33fb6683e4ed71a781b38570ed
 SHA512:
-  metadata.gz: a0408cdf917450acb12259956dd8852654cd154cd0f0fd5b7d482a7773c305985fd3300677a62461903d7d52eee1357215c5efd6372c641f10298dee607a74ea
-  data.tar.gz: b9696acda5c66d2c2c5cd17817010b52d88adc09f3bb23340a157b70c5db8312e291c07096145a0ecb76e8b1adb1d66847ab8548db614928a85fc67352c1075d
+  metadata.gz: 371fa3174dd1a28f9ec212b5e8452ab5f832ad20537f6172905f029a63425ec75b186d8d9cf70d59c58bf2c508981f649a117db647006aad6b075119337f9005
+  data.tar.gz: 29b690656735cf22ba37b56aa2d54db8226fe4398bbd8a0da3d10c2f94ec35b829ae6d7c20de80211a19ef61e0fcf89492b0e6775b85ad21177b8ed4b36b3b9d

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 *.gem
-.DS_Store
+.DS_Store
+.idea/

data/README.md

@@ -1,6 +1,6 @@
 # [![Ruby Gem Icon](https://raw.githubusercontent.com/zenkay/dandelionapi-ruby/master/rubygem.png)](https://rubygems.org/gems/dandelionapi) Dandelion API Ruby Gem
 
-[![Code Climate](https://codeclimate.com/github/zenkay/dandelionapi-ruby/badges/gpa.svg)](https://codeclimate.com/github/zenkay/dandelionapi-ruby) [![Travis CI](https://travis-ci.org/zenkay/dandelionapi-ruby.svg?branch=master)](https://travis-ci.org/zenkay/dandelionapi-ruby) [![Gem Version](https://badge.fury.io/rb/dandelionapi.svg)](http://badge.fury.io/rb/dandelionapi) [![Coverage Status](https://coveralls.io/repos/zenkay/dandelionapi-ruby/badge.svg)](https://coveralls.io/r/zenkay/dandelionapi-ruby)
+[![Code Climate](https://codeclimate.com/github/zenkay/dandelionapi-ruby/badges/gpa.svg)](https://codeclimate.com/github/zenkay/dandelionapi-ruby) [![Travis CI](https://travis-ci.org/zenkay/dandelionapi-ruby.svg?branch=master)](https://travis-ci.org/zenkay/dandelionapi-ruby) [![Gem Version](https://badge.fury.io/rb/dandelionapi.svg)](http://badge.fury.io/rb/dandelionapi) [![Coverage Status](https://coveralls.io/repos/github/zenkay/dandelionapi-ruby/badge.svg?branch=master)](https://coveralls.io/github/zenkay/dandelionapi-ruby?branch=master)
 
 ## Installation
 
@@ -15,14 +15,14 @@ And then execute:
 ```
 $ bundle install
 ```
+
 ## Setup
 
 Setup configuration parameters
 
 ```
 Dandelionapi.configure do |c|
-  c.app_id = "your-app-id-for-dandelionapi-account"
-  c.app_key = "your-app-key-for-dandelionapi-account"
+  c.token = "your-token-for-dandelionapi-account"
   c.endpoint = "https://api.dandelion.eu/"
 end
 ```
@@ -62,13 +62,14 @@ response = element.analyze(text: "I'm really disappointed")
 
 ## About the DandelionAPI project
 
-This library is part of a larger group of libraries used to explore best strategies to build packages among multiple languages. Each library is written using conventions about coding style, filesystem structure, testing, documentation and distribution typical of the language enviroment but preserve the library main concepts. This version use the following conventions:
+This library is part of a larger group of libraries used to explore best strategies to build packages among multiple languages. Each library is written using conventions about coding style, filesystem structure, testing, documentation and distribution typical of the language enviroment but preserve the library main concepts. This version use the following conventions for the **Ruby** environment:
 
 - Tested using [RSpec](http://rspec.info/)
 - Documented using [YARD](http://yardoc.org/)
+- Quality monitored using [Travis CI](https://travis-ci.org/), [Code Climate](https://codeclimate.com/) and [Coveralls](https://coveralls.io/)
 - Packed using [Bundler](http://bundler.io/) and [Gem](https://rubygems.org/)
 - Distributed over [RubyGems](https://rubygems.org/) as [dandelionapi](https://rubygems.org/gems/dandelionapi)
 
 ----
 
-Here is the complete list of libraries available: [Ruby](https://github.com/zenkay/dandelionapi-ruby), [PHP](https://github.com/zenkay/dandelionapi-php), [Node](https://github.com/zenkay/dandelionapi-node)
+Here is the complete list of available libraries: [Ruby](https://github.com/zenkay/dandelionapi-ruby), [PHP](https://github.com/zenkay/dandelionapi-php), [Node](https://github.com/zenkay/dandelionapi-node), [Python](https://github.com/zenkay/dandelionapi-python)

data/lib/dandelionapi.rb

@@ -3,6 +3,8 @@
 require "dandelionapi/version"
 
 require "dandelionapi/base"
+require "dandelionapi/analysis"
+require "dandelionapi/comparison"
 require "dandelionapi/entity_extraction"
 require "dandelionapi/text_similarity"
 require "dandelionapi/language_detection"
@@ -14,7 +16,7 @@ module Dandelionapi
   #
   # @example
   #   Dandelionapi.configure do |c|
-  #     c.app_id = "test"
+  #     c.token = "test"
   #   end
   #
   def self.configure(&block)
@@ -24,7 +26,7 @@ module Dandelionapi
   # Return configuration parameters
   #
   # @example
-  #   Dandelionapi.config.app_id
+  #   Dandelionapi.config.token
   #
   def self.config
     @config
@@ -33,7 +35,7 @@ module Dandelionapi
   # Container for configuration parameters
   #
   class Configuration
-    attr_accessor :app_id, :app_key, :endpoint
+    attr_accessor :token, :endpoint, :path
   end
 
   # Exception raised for connection error
@@ -42,5 +44,14 @@ module Dandelionapi
 
   # Exception raised when a mandatory parameter is missing
   #  
-  class MissingParameters < Exception; end
+  class MissingParameter < Exception; end
+
+  # Exception raised when more than one require parameter is given
+  #  
+  class TooManyParameters < Exception; end
+
+  # Exception raised when a parameter is in the wrong format
+  #  
+  class WrongParameterFormat < Exception; end
+
 end

data/lib/dandelionapi/analysis.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+  module Analysis
+
+    class Request < Base::Request
+
+      def analyze(options)
+        params = filter_permitted_params options
+
+        if required_params_missing? params
+          raise MissingParameter.new "Please provide one of the following parameters: #{self.class::MANDATORY_FIELDS.join(", ")} as input"
+        end
+
+        if too_many_mandatory_parameters? params, 1
+          raise TooManyParameters.new "Please provide only one of the following parameters: #{self.class::MANDATORY_FIELDS.join(", ")} as input"        
+        end
+
+        verify_format params do |wrong_param|
+          raise WrongParameterFormat.new "Wrong format: #{self.class::FIELDS_FORMAT[wrong_param][:error_message]}"  
+        end
+
+        call(self.class::ENDPOINT, params)
+      end
+
+      protected
+
+      def filter_permitted_params options
+        params = {}
+        options.each { |key, value| params[key.to_s] = value }
+        params.select { |key,value| (self.class::MANDATORY_FIELDS + self.class::OPTIONAL_FIELDS).include? key }
+      end
+
+      def required_params_missing? params
+        mandatory_fields_count(params) == 0
+      end
+
+      def too_many_mandatory_parameters? params, max
+        mandatory_fields_count(params) > max
+      end
+
+      def mandatory_fields_count params
+        (self.class::MANDATORY_FIELDS & params.keys).size
+      end
+
+      def verify_format params, &block
+        params.each do |key, value|
+          if self.class::FIELDS_FORMAT[key] and self.class::FIELDS_FORMAT[key][:valid]
+            yield key unless self.class::FIELDS_FORMAT[key][:valid].call value
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/dandelionapi/base.rb

@@ -1,32 +1,29 @@
 # encoding: UTF-8
 
-require "faraday"
-require "faraday_middleware"
-require "json"
-
 module Dandelionapi
+  module Base
 
-  class Base
+    class Request
 
-    protected
+      protected
 
-    def call(endpoint, params)
-      begin
-        params = params.merge(
-          :$app_id => Dandelionapi.config.app_id,
-          :$app_key => Dandelionapi.config.app_key
-        )
-        conn = Faraday.new(url: Dandelionapi.config.endpoint) do |faraday|
-          faraday.request  :url_encoded
-          faraday.adapter  Faraday.default_adapter
+      def call(endpoint, params)
+        begin
+          params = params.merge(
+            :token => Dandelionapi.config.token
+          )
+          conn = Faraday.new(url: Dandelionapi.config.endpoint) do |faraday|
+            faraday.request  :url_encoded
+            faraday.adapter  Faraday.default_adapter
+          end
+          response = conn.post "#{Dandelionapi.config.path}#{endpoint}", params
+          JSON.parse response.body
+        rescue Exception => e
+          raise Dandelionapi::BadResponse
         end
-        response = conn.post endpoint, params
-        JSON.parse response.body
-      rescue Exception => e
-        raise Dandelionapi::BadResponse
       end
+
     end
 
   end
-
 end

data/lib/dandelionapi/comparison.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+  module Comparison
+
+    class Request < Base::Request
+
+      def compare(options)
+      end
+
+    end
+
+  end
+end

data/lib/dandelionapi/entity_extraction.rb

@@ -5,24 +5,86 @@ require "faraday_middleware"
 require "json"
 
 module Dandelionapi
+  module EntityExtraction
+    
+    class Request < Analysis::Request
 
-  class EntityExtraction < Base
+      ENDPOINT = "/nex/v1"
 
-    ENDPOINT = "/datatxt/nex/v1"
+      MANDATORY_FIELDS = [
+        "text",
+        "url",
+        "html",
+        "html_fragment"
+      ]
 
-    attr_accessor :text, :url, :html, :html_fragment, 
-    	:lang, :min_confidence, :min_length, :social_hashtag, 
-    	:social_mention, :include, :extra_types, :country, 
-    	:custom_spots
+      OPTIONAL_FIELDS = [
+        "lang",
+        "min_confidence",
+        "min_length",
+        "social.hashtag",
+        "social.mention",
+        "include",
+        "extra_types",
+        "country",
+        "custom_spots"
+      ]
 
-    def analyze(options)
+      FIELDS_FORMAT = {
+        "text" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'text needs to be a String'
+        }, 
+        "url" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'url needs to be a String'
+        },  
+        "html" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'html needs to be a String'
+        },  
+        "html_fragment" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'html_fragment needs to be a String'
+        }, 
+        "lang" => {
+          valid: lambda {|value| (value.is_a? String and ["de", "en", "fr", "it", "pt", "auto"].include? value)},
+          error_message: 'lang needs to be one of the following values: "de", "en", "fr", "it", "pt", "auto"'
+        }, 
+        "min_confidence" => { 
+          valid: lambda {|value| (value.is_a? Float and [0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0].include? value) },
+          error_message: 'wrong format'
+        }, 
+        "min_length" => {
+          valid: lambda {|value| (value.is_a? Integer and value >= 2) },
+          error_message: 'wrong format'
+        }, 
+        "social.hashtag" => {
+          valid: lambda {|value| (value.is_a? TrueClass or value.is_a? FalseClass)},
+          error_message: 'wrong format'
+        }, 
+        "social.mention" => {
+          valid: lambda {|value| (value.is_a? TrueClass or value.is_a? FalseClass)},
+          error_message: 'wrong format'
+        }, 
+        "include" => {
+          valid: lambda {|values| (values.is_a? Array and values.all?{|value|["types", "categories", "abstract", "image", "lod", "alternate_labels"].include? value})},
+          error_message: 'wrong format'
+        }, 
+        "extra_types" => {
+          valid: lambda {|values| (values.is_a? Array and values.all?{|value|["phone", "vat"].include? value})},
+          error_message: 'wrong format'
+        }, 
+        "country" => {
+          valid: lambda {|value| ["AD", "AE", "AM", "AO", "AQ", "AR", "AU", "BB", "BR", "BS", "BY", "CA", "CH", "CL", "CN", "CX", "DE", "FR", "GB", "HU", "IT", "JP", "KR", "MX", "NZ", "PG", "PL", "RE", "SE", "SG", "US", "YT", "ZW"].include? value},
+          error_message: 'wrong format'
+        }, 
+        "custom_spots" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'custom_spots needs to be a String'
+        }
+      }
 
-      raise MissingParameters.new("Please provide one of the following parameters: text, url, html or html_fragment") if ([:text, :url, :html, :html_fragment] & options.keys).empty?
-
-      params = options
-      call(ENDPOINT, params)
     end
-
   end
-
 end

data/lib/dandelionapi/language_detection.rb

@@ -5,21 +5,47 @@ require "faraday_middleware"
 require "json"
 
 module Dandelionapi
+  module LanguageDetection
+
+  	class Request < Analysis::Request
+
+      ENDPOINT = "/li/v1"
+
+      MANDATORY_FIELDS = [
+        "text",
+        "url",
+        "html",
+        "html_fragment"
+      ]
+
+      OPTIONAL_FIELDS = [
+        "clean"
+      ]
+
+      FIELDS_FORMAT = {
+        "text" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'text needs to be String'
+        }, 
+        "url" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'url needs to be String'
+        },  
+        "html" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'html needs to be String'
+        },  
+        "html_fragment" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'html_fragment needs to be String'
+        }, 
+        "clean" => {
+          valid: lambda {|value| (value.is_a? TrueClass or value.is_a? FalseClass)},
+          error_message: 'clean needs to be Boolean'
+        }, 
+      }
 
-  class LanguageDetection < Base
-
-    ENDPOINT = "/datatxt/li/v1"
-
-    attr_accessor :text, :url, :html, :html_fragment, :clean
-
-    def analyze(options)
-
-      raise MissingParameters.new("Please provide one of the following parameters: text, url, html or html_fragment") if ([:text, :url, :html, :html_fragment] & options.keys).empty?
-
-      params = options
-      call(ENDPOINT, params)
     end
 
   end
-
 end

data/lib/dandelionapi/sentiment_analysis.rb

@@ -6,18 +6,46 @@ require "json"
 
 module Dandelionapi
 
-  class SentimentAnalysis < Base
+  module SentimentAnalysis
+
+    class Request < Analysis::Request
+
+      ENDPOINT = "/sent/v1"
+
+      MANDATORY_FIELDS = [
+        "text",
+        "url",
+        "html",
+        "html_fragment"
+      ]
+
+      OPTIONAL_FIELDS = [
+        "lang"
+      ]
+
+      FIELDS_FORMAT = {
+        "text" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'text needs to be String'
+        }, 
+        "url" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'url needs to be String'
+        },  
+        "html" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'html needs to be String'
+        },  
+        "html_fragment" => {
+          valid: lambda {|value| value.is_a? String},
+          error_message: 'html_fragment needs to be String'
+        }, 
+        "lang" => {
+          valid: lambda {|value| (value.is_a? String and ["de", "en", "fr", "it", "pt", "auto"].include? value)},
+          error_message: 'lang needs to be one of the following values: "de", "en", "fr", "it", "pt", "auto"'
+        } 
+      }
 
-    ENDPOINT = "/datatxt/sent/v1"
-
-    attr_accessor :text, :url, :html, :html_fragment, :lang
-
-    def analyze(options)
-
-      raise MissingParameters.new("Please provide one of the following parameters: text, url, html or html_fragment") if ([:text, :url, :html, :html_fragment] & options.keys).empty?
-
-      params = options
-      call(ENDPOINT, params)
     end
 
   end

data/lib/dandelionapi/text_similarity.rb

@@ -6,17 +6,37 @@ require "json"
 
 module Dandelionapi
 
-  class TextSimilarity < Base
+  class TextSimilarity
 
-    ENDPOINT = "/datatxt/sim/v1"
+  	class Request < Comparison::Request
 
-    attr_accessor :text1, :url1, :html1, :html_fragment1, :text2, :url2, :html2, :html_fragment2, :lang, :bow
+	    ENDPOINT = "/sim/v1"
 
-    def analyze(options)
-      params = options
-      call(ENDPOINT, params)
-    end
+      MANDATORY_FIELDS_1 = [
+        "text1",
+        "url1",
+        "html1",
+        "html_fragment1"
+      ]
+
+      MANDATORY_FIELDS_2 = [
+        "text2",
+        "url2",
+        "html2",
+        "html_fragment2"
+      ]
+
+      OPTIONAL_FIELDS = [
+        "lang",
+        "bow"
+      ]
 
+	    def compare(options)
+	      params = options
+	      call(ENDPOINT, params)
+	    end
+
+    end
   end
 
 end

data/lib/dandelionapi/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Dandelionapi
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dandelionapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrea Mostosi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -182,7 +182,9 @@ files:
 - bin/setup
 - dandelionapi.gemspec
 - lib/dandelionapi.rb
+- lib/dandelionapi/analysis.rb
 - lib/dandelionapi/base.rb
+- lib/dandelionapi/comparison.rb
 - lib/dandelionapi/entity_extraction.rb
 - lib/dandelionapi/language_detection.rb
 - lib/dandelionapi/sentiment_analysis.rb
@@ -209,9 +211,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for Dandelion API service
 test_files: []
-has_rdoc: