dandelionapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9207ec230e110a9845eaf6d8daacb4f41ac6be1
+  data.tar.gz: 693aedb6c8b538106c44a9f21c4abca183ff2fce
+SHA512:
+  metadata.gz: b0f3a098862eff987c89fe905c20bb260d50f711da5295e43c77af00375a6de34a52d6e31bf0f53f46b3c959873bfbba4b0625f069fa54acaba010ea89875349
+  data.tar.gz: 8816f5f5685d9ebd96dc2073beb58ba8b8853cb1abcd7793d4743b1a3fbc4b2042acec7efc2f867768188ee09f0b0741debc15895384ca32cf9bc135df9798dd

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.2.1
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrea Mostosi
+
+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,53 @@
+# [![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.png?branch=master)](https://coveralls.io/r/zenkay/dandelionapi-ruby?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'dandelionapi'
+```
+
+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.endpoint = "https://api.dandelion.eu/"
+end
+```
+
+## Usage
+
+_Methods references are taken from [Dandelion API's documentation](https://dandelion.eu/docs/)._
+
+**Entity Extraction API**: is a named entity extraction & linking API that performs very well even on short texts, on which many other similar services do not. dataTXT-NEX currently works on English, French, German, Italian and Portuguese texts. With this API you will be able to automatically tag your texts, extracting Wikipedia entities and enriching your data.
+
+```
+element = Dandelionapi::EntityExtraction.new
+response = element.analyze(text: "This is a test")
+```
+
+**Text Similarity API**: is a semantic sentence similarity API optimized on short sentences. With this API you will be able to compare two sentences and get a score of their semantic similarity. It works even if the two sentences don't have any word in common.
+
+```
+element = Dandelionapi::TextSimilarity.new
+response = element.analyze(text1: "This is a test", text2: "This is another test")
+```
+
+**Language Detection API**: is a simple language identification API; it is a tool that may be useful when dealing with texts, so we decided to open it to all our users. It currently supports more than 50 languages.
+
+```
+element = Dandelionapi::LanguageDetection.new
+response = element.analyze(text: "Questo è un test")
+```

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 "dandelionapi"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dandelionapi.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dandelionapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dandelionapi"
+  spec.version       = Dandelionapi::VERSION
+  spec.authors       = ["Andrea Mostosi"]
+  spec.email         = ["andrea.mostosi@zenkay.net"]
+
+  spec.summary       = %q{Ruby Gem for Dandelion API service}
+  spec.description   = %q{Ruby Gem for Dandelion API service. Available endpoint: Entity Extraction, Text Similarity and Language Detection}
+  spec.homepage      = "https://github.com/zenkay/dandelionapi-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "faraday", '~> 0.9', '>= 0.9.0'
+  spec.add_dependency "faraday_middleware", '~> 0.9', '>= 0.9.1'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec","~> 3.3"
+  spec.add_development_dependency "vcr", "~> 2.4"
+  spec.add_development_dependency "webmock", "~> 1.17"
+  spec.add_development_dependency "simplecov", "~> 0.8"
+  spec.add_development_dependency "coveralls", "~> 0.7"
+end

data/lib/dandelionapi.rb

@@ -0,0 +1,23 @@
+require "dandelionapi/version"
+
+require "dandelionapi/base"
+require "dandelionapi/entity_extraction"
+require "dandelionapi/text_similarity"
+require "dandelionapi/language_detection"
+
+module Dandelionapi
+  def self.configure(&block)
+    yield @config ||= Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    attr_accessor :app_id, :app_key, :endpoint
+  end
+
+  class BadResponse < Exception; end
+  class BadParameters < Exception; end
+end

data/lib/dandelionapi/base.rb

@@ -0,0 +1,30 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+
+  class Base
+
+    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
+        end
+        response = conn.post endpoint, params
+        JSON.parse response.body
+      rescue Exception => e
+        raise Dandelionapi::BadResponse
+      end
+    end
+
+  end
+
+end

data/lib/dandelionapi/entity_extraction.rb

@@ -0,0 +1,23 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+
+  class EntityExtraction < Base
+
+    ENDPOINT = "/datatxt/nex/v1"
+
+    attr_accessor :text, :url, :html, :html_fragment, :lang, :min_confidence, :min_length, :social_hashtag, :social_mention, :include, :extra_types, :country, :custom_spots
+
+    def analyze(options)
+
+      raise BadParameters.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

@@ -0,0 +1,20 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+
+  class LanguageDetection < Base
+
+    ENDPOINT = "/datatxt/li/v1"
+
+    attr_accessor :text, :url, :html, :html_fragment, :clean
+
+    def analyze(options)
+      params = options
+      call(ENDPOINT, params)
+    end
+
+  end
+
+end

data/lib/dandelionapi/text_similarity.rb

@@ -0,0 +1,20 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+
+  class TextSimilarity < Base
+
+    ENDPOINT = "/datatxt/sim/v1"
+
+    attr_accessor :text1, :url1, :html1, :html_fragment1, :text2, :url2, :html2, :html_fragment2, :lang, :bow
+
+    def analyze(options)
+      params = options
+      call(ENDPOINT, params)
+    end
+
+  end
+
+end

data/lib/dandelionapi/version.rb

@@ -0,0 +1,3 @@
+module Dandelionapi
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: dandelionapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrea Mostosi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 'Ruby Gem for Dandelion API service. Available endpoint: Entity Extraction,
+  Text Similarity and Language Detection'
+email:
+- andrea.mostosi@zenkay.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dandelionapi.gemspec
+- lib/dandelionapi.rb
+- lib/dandelionapi/base.rb
+- lib/dandelionapi/entity_extraction.rb
+- lib/dandelionapi/language_detection.rb
+- lib/dandelionapi/text_similarity.rb
+- lib/dandelionapi/version.rb
+- rubygem.png
+homepage: https://github.com/zenkay/dandelionapi-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby Gem for Dandelion API service
+test_files: []
+has_rdoc: