yooda-client 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfae9f593db9d56d3c012cc2a66fd66deb31d04b
+  data.tar.gz: 7b46bef1fdf213de65b3697b1c70f009b1c132e2
+SHA512:
+  metadata.gz: d606cd9aefa35477af1fe7bb28d858bf5079a5354f6ef9ed2b0199ebe121a6f32bf7f996b929e839eb22a409b0c0beaa95c83ca8e613801b4cc4f9c33f0186e0
+  data.tar.gz: 94bb33037dad2e80c06fbbbc0c29b5ea5ec072774c07f85d49472963d1e5f2a03fc12cec945b342364e1f6fd09000d7bb2da0cb987169d706630c07a019d98d7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+yooda-client-*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

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 oros.ogmius@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 yooda-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    yooda-client (0.1.2)
+      faraday (~> 0.13)
+      faraday_middleware
+      hashie (~> 3.5)
+      multi_json (~> 1.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashie (3.5.6)
+    multi_json (1.12.2)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yooda-client!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bastien Montois
+
+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,43 @@
+# Yooda::Client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yooda/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yooda-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yooda-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 https://github.com/[USERNAME]/yooda-client. 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 Yooda::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yooda-client/blob/master/CODE_OF_CONDUCT.md).

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 "yooda/client"
+
+# 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/yooda.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'yooda/domains'
+require 'yooda/keywords'
+require 'yooda/subscriptions'
+
+Dir[File.dirname(__FILE__) + '/yooda/*.rb'].each {|file| require file }
+
+module Yooda
+
+  class << self
+
+    attr_accessor :apikey, :connection_middleware
+
+    def configure
+      yield self
+      true
+    end
+
+  end
+
+end

data/lib/yooda/api_error.rb

@@ -0,0 +1,19 @@
+module Yooda
+  class APIError < StandardError
+
+    attr_reader :status
+    attr_reader :reason
+    attr_reader :response
+
+    def initialize(status, reason, response)
+      @status = status
+      @reason = reason
+      @response = response
+    end
+
+    def message
+      "#{@reason}: #{@response} (#{@status})"
+    end
+    alias :to_s :message
+  end
+end

data/lib/yooda/client.rb

@@ -0,0 +1,66 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require_relative 'api_error'
+require_relative 'domains'
+require_relative 'keywords'
+require_relative 'subscriptions'
+
+module Yooda
+
+  class Client
+
+    DEFAULT_CONNECTION_MIDDLEWARE = [
+      Faraday::Request::Multipart,
+      Faraday::Request::UrlEncoded,
+      FaradayMiddleware::Mashify,
+      FaradayMiddleware::ParseJson
+    ]
+
+    include Yooda::Domains
+    include Yooda::Keywords
+    include Yooda::Subscriptions
+
+    attr_reader :apikey
+
+    def initialize(options={})
+      @apikey = options[:apikey] || Yooda.apikey
+      @connection_middleware = options[:connection_middleware] || Yooda.connection_middleware || []
+      @connection_middleware += DEFAULT_CONNECTION_MIDDLEWARE
+    end
+
+    def connection
+      params = {}
+      params[:apikey] = @apikey if @apikey
+      @connection ||= Faraday::Connection.new(:url => api_url, :params => params, :headers => default_headers) do |builder|
+        # @connection_middleware.each do |middleware|
+        #   builder.use *middleware
+        # end
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def api_url
+      "https://api.yooda.com"
+    end
+
+    def return_error_or_body(response)
+      if response.status == 200
+        response.body.content
+      else
+        raise Yooda::APIError.new(response.status, response.reason_phrase, response.body)
+      end
+    end
+
+    private
+
+    def default_headers
+      headers = {
+        :accept =>  'application/json',
+        :user_agent => 'Yooda client API'
+      }
+    end
+
+  end
+
+end

data/lib/yooda/domains.rb

@@ -0,0 +1,32 @@
+module Yooda
+  module Domains
+
+    # GET /insight/domains/{domain_id}/keywords
+    # Liste des expressions de recherches positionnées d'un site
+    def keywords_market_by_domain(domain_id, options={})
+      response = connection.get do |req|
+        req.url "insight/domains/#{domain_id}/keywords", options
+      end
+      return_error_or_body(response)
+    end
+
+    # GET /insight/domains/{domain_id}/kpi
+    # Récupérer les indicateurs clés de performance d'un site pour un domain donnée.
+    def domain_market_kpi(domain_id, options={})
+      response = connection.get do |req|
+        req.url "insight/domains/#{domain_id}/kpi", options
+      end
+      return_error_or_body(response)
+    end
+
+    # GET /insight/domains/{url}
+    # Retourne les informations d'un domaine pour une url donnée
+    def domain_informations(domain, options={})
+      response = connection.get do |req|
+        req.url "insight/domains/#{domain}", options
+      end
+      return_error_or_body(response)
+    end
+
+  end
+end

data/lib/yooda/keywords.rb

@@ -0,0 +1,32 @@
+module Yooda
+  module Keywords
+
+    # GET /insight/keywords/market/by/keywords/{kw_id}
+    # Liste des expressions de recherche à partir d'un mot-clé
+    def keywords_market_by_keyword(kw_id, options={})
+      response = connection.get do |req|
+        req.url "insight/keywords/market/by/keywords/#{kw_id}", options
+      end
+      return_error_or_body(response)
+    end
+
+    # GET /insight/keywords/{keyword}
+    # Retourne les informations sur un mot-clé
+    def keyword_informations(keyword, options={})
+      response = connection.get do |req|
+        req.url "insight/keywords/#{keyword}", options
+      end
+      return_error_or_body(response)
+    end
+
+    # GET /insight/keywords/{kw_id}/market/kpi
+    # Récupérer les indicateurs clés de performance d'un mot-clé.
+    def keyword_market_kpi(kw_id, options={})
+      response = connection.get do |req|
+        req.url "insight/keywords/#{kw_id}/market/kpi", options
+      end
+      return_error_or_body(response)
+    end
+
+  end
+end

data/lib/yooda/subscriptions.rb

@@ -0,0 +1,19 @@
+module Yooda
+  module Subscriptions
+
+    def credits(options={})
+      response = connection.get do |req|
+        req.url "subscriptions/credits", options
+      end
+      return_error_or_body(response)
+    end
+
+    def histories(options={})
+      response = connection.get do |req|
+        req.url "subscriptions/histories", options
+      end
+      return_error_or_body(response)
+    end
+
+  end
+end

data/lib/yooda/version.rb

@@ -0,0 +1,22 @@
+module Yooda
+
+  class Version
+    MAJOR = 0 unless defined? Yooda::Version::MAJOR
+    MINOR = 1 unless defined? Yooda::Version::MINOR
+    PATCH = 3 unless defined? Yooda::Version::PATCH
+    PRE = nil unless defined? Yooda::Version::PRE
+
+    class << self
+
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s.freeze
+
+end

data/yooda-client.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yooda/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yooda-client"
+  spec.version       = Yooda::Version
+  spec.authors       = ["Bastien Montois"]
+  spec.email         = ["bastien@la-revanche-des-sites.fr"]
+
+  spec.summary       = %q{Simple ruby gem to wrap Yooda.com API}
+  spec.description   = %q{Simple ruby gem to wrap Yooda.com API -- a SEO market monitoring toolkit.}
+  spec.homepage      = "https://github.com/larevanchedessites/yooda-api-ruby-client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "faraday", "~> 0.13"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "hashie", "~> 3.5"
+  spec.add_dependency "multi_json", "~> 1.12"
+
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: yooda-client
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Bastien Montois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: Simple ruby gem to wrap Yooda.com API -- a SEO market monitoring toolkit.
+email:
+- bastien@la-revanche-des-sites.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yooda.rb
+- lib/yooda/api_error.rb
+- lib/yooda/client.rb
+- lib/yooda/domains.rb
+- lib/yooda/keywords.rb
+- lib/yooda/subscriptions.rb
+- lib/yooda/version.rb
+- yooda-client.gemspec
+homepage: https://github.com/larevanchedessites/yooda-api-ruby-client
+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: Simple ruby gem to wrap Yooda.com API
+test_files: []