meaning_cloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34f1f48e75b3338341481f5331a42f4390e5b53de5c379112ab7d386549f6e1c
+  data.tar.gz: b7194c9db2f800b1afa1eff73309f46c3a4b08d90f783546561a2aa3782a5048
+SHA512:
+  metadata.gz: bf604d7c2955c0007ad4290afedbd3b92890fa031647da1e69541865da6937e6692aab8e60ab8ff6f4c8605c51b02057434672ca1aba625897d76de8f0adbc06
+  data.tar.gz: d4cf84389273b45bc40a232063ea647a4406c391576340b9cca54d71d7297c73200a6e4583fd858245966287156a332a66ee9fcbd9d0715c879c65f7f5307a16

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.4
+  - 2.5.1
+  - ruby-head
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wakematta@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in meaning_cloud.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mohamed Ziata
+
+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,82 @@
+# MeaningCloud
+
+Meaning Cloud Ruby API Wrapper
+
+[![Build Status](https://travis-ci.org/WaKeMaTTa/meaning_cloud.svg?branch=master)](https://travis-ci.org/WaKeMaTTa/meaning_cloud)
+
+This gem is a ruby API wrapper for [Meaning Cloud](https://www.meaningcloud.com/) [API's](https://www.meaningcloud.com/developer/getting-started).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'meaning_cloud'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install meaning_cloud
+```
+
+## Usage
+
+### Pre-requirement
+
+You need a valid `key` to use the gem. You can get it by signing up [here](https://www.meaningcloud.com/developer/getting-started).
+
+If you don't set the `key` it will *raises an exception*.
+
+### Configuration
+
+You can use add initializer for example if you're on Rails.
+
+```ruby
+# config/initializers/meaning_cloud.rb
+
+MeaningCloud.configure do |config|
+  config.key = ENV['MEANING_CLOUD_KEY']                       # REQUIRED
+  config.language = :en                                       # optional, default is :en
+  config.topic_types = 'ec'                                   # optional, default is 'ec'
+  config.api_base = 'https://api.meaningcloud.com/topics-2.0' # optional, default is 'https://api.meaningcloud.com/topics-2.0'
+end
+```
+
+### Extract topics
+
+```ruby
+# Returns a hash of the parsed JSON result.
+result = MeaningCloud::Topics.extract_topics(txt: 'The most amazing text in the world')
+```
+Source [source](https://www.meaningcloud.com/developer/topics-extraction/doc/2.0/examples)
+
+## Status of the gem
+
+Current version only wraps the Topics extraction API's and is focused on specific usage. Feel free to send a pull request with more API's wrapped!
+
+The current gem is based in [TailorBrands/meaning-cloud](https://github.com/TailorBrands/meaning-cloud)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [meaning_cloud repository](https://github.com/wakematta/meaning_cloud). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MeaningCloud project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/meaning_cloud/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+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 'meaning_cloud'
+
+# 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(__FILE__)

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/lib/meaning_cloud.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'meaning_cloud/version'
+require 'meaning_cloud/topics'
+
+module MeaningCloud
+  API_BASE = ""
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  # Main configuration class.
+  class Configuration
+    attr_accessor :key, :language, :topic_types, :api_base
+
+    def initialize
+      @key = nil
+      @language = :en
+      @topic_types = 'ec'
+      @api_base = 'https://api.meaningcloud.com/topics-2.0'
+    end
+  end
+end

data/lib/meaning_cloud/topics.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rest_client'
+
+module MeaningCloud
+  # A class to hold all topic extraction related code.
+  #
+  # :reek:MissingSafeMethod { exclude: [ required_key! ] }
+  class Topics
+    attr_reader :options
+
+    def self.extract_topics(options = {})
+      new(options).call
+    end
+
+    def initialize(options = {})
+      @options = {
+        of: :json,
+        key: configuration.key,
+        lang: configuration.language,
+        tt: configuration.topic_types,
+        uw: 'y'
+      }.merge(options)
+    end
+
+    def call
+      required_key!(options)
+      result = RestClient.post(configuration.api_base, options)
+      JSON.parse(result)
+    end
+
+    private
+
+    def configuration
+      @configuration ||= MeaningCloud.configuration
+    end
+
+    def required_key!(options = {})
+      return if MeaningCloud.configuration.key || options[:key]
+
+      raise(MissingKeyError, 'Missing meaning cloud key')
+    end
+  end
+
+  # StandardError used when API Key is missing
+  class MissingKeyError < StandardError; end
+end

data/lib/meaning_cloud/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MeaningCloud
+  VERSION = '1.0.0'
+end

data/meaning_cloud.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'meaning_cloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'meaning_cloud'
+  spec.version       = MeaningCloud::VERSION
+  spec.authors       = ['Nadav Shatz' ,'Mohamed Ziata']
+  spec.email         = ['nadav@tailorbrands.com', 'wakematta@gmail.com']
+
+  spec.summary       = %q{An API wrapper for Meaning Cloud API's}
+  spec.description   = %q{A Gem to expose a wrapping API for the Meaning Cloud API's}
+  spec.homepage      = 'https://github.com/WaKeMaTTa/meaning_cloud'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest-client', '~> 2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'gem-release', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: meaning_cloud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nadav Shatz
+- Mohamed Ziata
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: A Gem to expose a wrapping API for the Meaning Cloud API's
+email:
+- nadav@tailorbrands.com
+- wakematta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/meaning_cloud.rb
+- lib/meaning_cloud/topics.rb
+- lib/meaning_cloud/version.rb
+- meaning_cloud.gemspec
+homepage: https://github.com/WaKeMaTTa/meaning_cloud
+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.7.7
+signing_key: 
+specification_version: 4
+summary: An API wrapper for Meaning Cloud API's
+test_files: []