majestic-api 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e1e35e83bb4074c2fea067e5049b0b7407ae08237b8d85ace5a76b081243fa9
+  data.tar.gz: afaf42abf89b9efbd9f79acfaea72ac20d26d0375843ab044f7a2d1a151ae69a
+SHA512:
+  metadata.gz: c6e2531fcae909e043e635e2ff75b40f992bcbf42ce18a5a19a9c12f61ce9cbabab6a659ef2c7ba9ffab05c73e6011fc49743fd8e92140a6a1db3d61a4300293
+  data.tar.gz: 25f597ae88854e0ce91cf2c5490ab9d8079aca5b1bdb6d6220f2371f1beea291f8e1fa77beeeb008f0bf8fa87c82eb8988e56434263e1a0a7f45cdc8e7fed586

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/bin/.pry_history
+.pry_history
+
+credentials.yml
+.ruby-version
+.ruby-gemset

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 sebastian.johnsson@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 scrapely.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    majestic-api (1.4.0)
+      faraday (>= 0.15.4)
+      faraday_middleware (>= 0.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.2.1)
+      actionview (= 5.2.2.1)
+      activesupport (= 5.2.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2.1)
+      activesupport (= 5.2.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    hashdiff (0.3.8)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2.1)
+      actionpack (= 5.2.2.1)
+      activesupport (= 5.2.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  generator_spec (>= 0.9.4)
+  majestic-api!
+  pry (~> 0.12.2)
+  rake (>= 10.0)
+  rspec (>= 3.0)
+  vcr (>= 4.0)
+  webmock (>= 3.5.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sebastian
+
+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.markdown

@@ -0,0 +1,25 @@
+# Majestic Ruby API Client #
+
+Client intended to be used with [Majestic's API](http://developer-support.majesticseo.com/).
+
+This gem is forked/rewritten based on [https://github.com/SebastianJ/Majestic-SEO-Api](https://github.com/SebastianJ/Majestic-SEO-Api).
+
+Majestic dropped the "SEO" brand a long time ago and the previous client's name was out of sync with this change.
+
+The client has also been slightly rewritten and prepared to be easier to maintain.
+
+## Installation ##
+```
+gem install majestic-api
+```
+
+## Configuration ##
+```
+Majestic::Api.configure do |config|
+  config.environment  =   :production # The environment to use, valid values: :sandbox, :production
+  config.api_key      =   'api_key' # Your API key provided by Majestic
+  config.verbose      =   false # Set to true to enable Faraday's logging middleware to get more information
+end
+```
+
+If you're using Rails, create an initializer in config/initializers/majestic.rb to configure the client globally in your app.

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,34 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "majestic/api"
+require "yaml"
+
+# 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
+
+cfg_path                =   File.join(File.dirname(__FILE__), "../credentials.yml")
+
+if File.exists?(cfg_path)
+  yaml                  =   YAML.load_file(cfg_path)["development"]
+
+  Majestic::Api.configure do |config|
+    config.environment  =   yaml.fetch("environment", :sandbox)
+    config.api_key      =   yaml.fetch("api_key", nil)
+    config.verbose      =   true
+  end
+end
+
+# 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.
+
+require "pry"
+Pry.config.history.file = File.join(__FILE__, "../.pry_history")
+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/majestic/api.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'majestic/api/version'
+
+if !String.instance_methods(false).include?(:underscore)
+  require 'majestic/api/extensions/string'
+end
+
+require 'majestic/api/configuration'
+
+require 'majestic/api/logger'
+require 'majestic/api/exceptions'
+
+require 'majestic/api/response'
+require 'majestic/api/item_info_response'
+require 'majestic/api/item_info'
+require 'majestic/api/client'
+
+require 'majestic/api/railtie' if defined?(Rails)
+
+module Majestic
+  module Api
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= ::Majestic::Api::Configuration.new
+    end
+
+    def self.reset
+      @configuration = ::Majestic::Api::Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+  end
+end

data/lib/majestic/api/client.rb

@@ -0,0 +1,106 @@
+module Majestic
+  module Api
+
+    class Client
+      attr_accessor :configuration, :connection, :api_url
+      include Majestic::Api::Logger
+
+    	def initialize(configuration: ::Majestic::Api.configuration)
+        self.configuration    =   configuration
+    		
+        set_api_url
+    		set_connection
+    	end
+      
+    	def set_api_url(format = :json)
+        self.api_url          =   case self.configuration.environment.to_sym
+          when :sandbox     then "http://developer.majestic.com/api/#{format}"
+          when :production  then "http://api.majestic.com/api/#{format}"
+          else
+            "http://developer.majestic.com/api/#{format}"
+        end
+      end
+
+    	def set_connection(headers: {})        
+        headers         =   {
+          "User-Agent"    =>  self.configuration.user_agent,
+          "Content-Type"  =>  "application/json"
+        }.merge(headers)
+        
+    	  self.connection = Faraday.new(url: self.api_url, ssl: {verify: false}) do |builder|
+          builder.headers     =   headers
+          
+          builder.request  :url_encoded
+          builder.request  :retry
+          builder.response :json
+          builder.response :logger if self.configuration.verbose
+          builder.adapter  :net_http
+        end
+    	end
+
+    	def get_index_item_info(urls:, params: {}, options: {})
+    	  request_parameters                    =   {}
+    	  request_parameters[:datasource]       =   params.fetch(:data_source, "historic")
+        request_parameters[:items]            =   urls.size
+
+        urls.each_with_index do |url, index|
+          request_parameters["item#{index}"]  =   url
+        end
+
+        response    =   self.execute_command("GetIndexItemInfo", params: request_parameters, options: options)
+        response    =   Majestic::Api::ItemInfoResponse.new(response)
+
+        return response
+    	end
+
+    	# This method will execute the specified command as an api request.
+    	# 'name' is the name of the command you wish to execute, e.g. GetIndexItemInfo
+    	# 'parameters' a hash containing the command parameters.
+    	# 'timeout' specifies the amount of time to wait before aborting the transaction. This defaults to 5 seconds.
+    	def execute_command(name, params: {}, options: {})
+    		params.merge!({
+          app_api_key: self.configuration.api_key,
+          cmd:         name
+        })
+        
+    		self.execute_request(params: params, options: options)
+    	end
+
+    	# This will execute the specified command as an OpenApp request.
+    	# 'command_name' is the name of the command you wish to execute, e.g. GetIndexItemInfo
+    	# 'parameters' a hash containing the command parameters.
+    	# 'access_token' the token provided by the user to access their resources.
+    	# 'timeout' specifies the amount of time to wait before aborting the transaction. This defaults to 5 seconds.
+    	def execute_open_app_request(command_name, access_token, params: {}, options: {})
+    		params.merge!({
+          accesstoken: access_token,
+          cmd:         command_name,
+          privatekey:  self.configuration.api_key
+        })
+        
+    		self.execute_request(params: params, options: options)
+    	end
+
+    	# 'parameters' a hash containing the command parameters.
+    	# 'options'  a hash containing command/call options (timeout, proxy settings etc)
+    	def execute_request(params: {}, options: {})
+        response        =   nil
+        
+        log(:info, "[Majestic::Api::Client] - Sending API Request to Majestic SEO. Parameters: #{params.inspect}. Options: #{options.inspect}")
+        
+        response        =   self.connection.get do |request|
+          request.params                    =   params  if params && !params.empty?
+          request.options                   =   options if options && !options.empty?
+        end
+        
+    		return response
+    	end
+      
+      def verbose
+        self.configuration.verbose
+      end
+
+    end
+
+  end
+end

data/lib/majestic/api/configuration.rb

@@ -0,0 +1,15 @@
+module Majestic
+  module Api
+    class Configuration
+      attr_accessor :environment, :api_key, :verbose, :user_agent
+    
+      def initialize
+        self.environment  =   :sandbox
+        self.api_key      =   nil
+        self.verbose      =   false
+        self.user_agent   =   "Ruby Majestic API Client v#{Majestic::Api::VERSION}"
+      end
+    
+    end
+  end
+end

data/lib/majestic/api/exceptions.rb

@@ -0,0 +1,5 @@
+module Majestic
+  module Api
+    class InsufficientIndexItemInfoUnitsException < StandardError; end
+  end
+end

data/lib/majestic/api/extensions/string.rb

@@ -0,0 +1,10 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+

data/lib/majestic/api/item_info.rb

@@ -0,0 +1,203 @@
+module Majestic
+  module Api
+    class ItemInfo
+      attr_accessor :data, :mappings
+      attr_accessor :index, :type, :url, :result_code, :success, :error_message, :status
+      attr_accessor :external_backlinks, :referring_domains, :indexed_urls, :analysis_results_unit_cost, :ac_rank
+      attr_accessor :get_top_backlinks_analysis_results_unit_cost, :download_backlinks_analysis_results_unit_cost, :download_referring_domains_analysis_results_unit_cost
+      attr_accessor :referring_ip_addresses, :referring_subnets
+      attr_accessor :referring_edu_domains, :external_edu_backlinks, :referring_gov_domains, :external_gov_backlinks
+      attr_accessor :exact_referring_edu_domains, :exact_external_edu_backlinks, :exact_referring_gov_domains, :exact_external_gov_backlinks
+      attr_accessor :crawled, :last_crawl_date, :last_crawl_result, :redirecting, :final_redirect_result, :last_seen
+      attr_accessor :outbound_domain_links, :outbound_external_backliks, :outbound_internal_backlinks, :outbound_links_pages
+      attr_accessor :title, :redirecting_to
+      attr_accessor :citation_flow, :trust_flow, :trust_metric
+      attr_accessor :crawled_urls, :root_domain_ip_address
+      attr_accessor :language_codes, :language_descriptions, :language_confidences, :language_page_ratios, :language_total_pages
+      attr_accessor :referring_language_codes, :referring_language_descriptions, :referring_language_confidences, :referring_language_page_ratios, :referring_language_total_pages
+      attr_accessor :total_non_unique_links, :non_unique_link_types, :non_unique_link_types_mappings
+      attr_accessor :referring_domain_types, :referring_domain_types_mappings
+      attr_accessor :hash_mappings
+      attr_accessor :topical_trust_flows
+
+      # This method returns a new instance of the Response class.
+      # If one of the parameters are not provided, it will default to nil.
+      def initialize(data)
+        self.data           =   data
+        
+        self.mappings       =   {
+          "ItemNum"                               =>    {:index                                           =>    :integer},
+          "ItemType"                              =>    {:type                                            =>    :integer},
+          "Item"                                  =>    {:url                                             =>    :string},
+          "ResultCode"                            =>    {:result_code                                     =>    :string},
+          "Status"                                =>    {:status                                          =>    :string},
+          "ExtBackLinks"                          =>    {:external_backlinks                              =>    :integer},
+          "RefDomains"                            =>    {:referring_domains                               =>    :integer},
+          "IndexedURLs"                           =>    {:indexed_urls                                    =>    :integer},
+          "AnalysisResUnitsCost"                  =>    {:analysis_results_unit_cost                      =>    :integer},
+          "ACRank"                                =>    {:ac_rank                                         =>    :integer},
+          "GetTopBackLinksAnalysisResUnitsCost"   =>    {:get_top_backlinks_analysis_results_unit_cost    =>    :integer},
+          "DownloadBacklinksAnalysisResUnitsCost" =>    {:download_backlinks_analysis_results_unit_cost   =>    :integer},
+          "DownloadRefDomainBacklinksAnalysisResUnitsCost"  => {:download_referring_domains_analysis_results_unit_cost   =>    :integer},
+          "RefIPs"                                =>    {:referring_ip_addresses                          =>    :integer},
+          "RefSubNets"                            =>    {:referring_subnets                               =>    :integer},
+          "RefDomainsEDU"                         =>    {:referring_edu_domains                           =>    :integer},
+          "ExtBackLinksEDU"                       =>    {:external_edu_backlinks                          =>    :integer},
+          "RefDomainsGOV"                         =>    {:referring_gov_domains                           =>    :integer},
+          "ExtBackLinksGOV"                       =>    {:external_gov_backlinks                          =>    :integer},
+          "RefDomainsEDU_Exact"                   =>    {:exact_referring_edu_domains                     =>    :integer},
+          "ExtBackLinksEDU_Exact"                 =>    {:exact_external_edu_backlinks                    =>    :integer},
+          "RefDomainsGOV_Exact"                   =>    {:exact_referring_gov_domains                     =>    :integer},
+          "ExtBackLinksGOV_Exact"                 =>    {:exact_external_gov_backlinks                    =>    :integer},
+          "CrawledFlag"                           =>    {:crawled                                         =>    :boolean},
+          "LastCrawlDate"                         =>    {:last_crawl_date                                 =>    :date},
+          "LastCrawlResult"                       =>    {:last_crawl_result                               =>    :string},
+          "RedirectFlag"                          =>    {:redirecting                                     =>    :boolean},
+          "FinalRedirectResult"                   =>    {:final_redirect_result                           =>    :string},
+          "LastSeen"                              =>    {:last_seen                                       =>    :string},
+          "OutDomainsExternal"                    =>    {:outbound_domain_links                           =>    :integer},
+          "OutLinksExternal"                      =>    {:outbound_external_backliks                      =>    :integer},
+          "OutLinksInternal"                      =>    {:outbound_internal_backlinks                     =>    :integer},
+          "OutLinksPages"                         =>    {:outbound_links_pages                            =>    :integer},
+          "Title"                                 =>    {:title                                           =>    :string},
+          "RedirectTo"                            =>    {:redirecting_to                                  =>    :string},
+          "CitationFlow"                          =>    {:citation_flow                                   =>    :integer},
+          "TrustFlow"                             =>    {:trust_flow                                      =>    :integer},
+          "TrustMetric"                           =>    {:trust_metric                                    =>    :integer},
+          "CrawledURLs"                           =>    {:crawled_urls                                    =>    :integer},
+          "RootDomainIPAddress"                   =>    {:root_domain_ip_address                          =>    :string},
+          "Language"                              =>    {:language_codes                                  =>    :string_array},
+          "LanguageDesc"                          =>    {:language_descriptions                           =>    :string_array},
+          "LanguageConfidence"                    =>    {:language_confidences                            =>    :integer_array},
+          "LanguagePageRatios"                    =>    {:language_page_ratios                            =>    :float_array},
+          "LanguageTotalPages"                    =>    {:language_total_pages                            =>    :integer},          
+          "RefLanguage"                           =>    {:referring_language_codes                        =>    :string_array},
+          "RefLanguageDesc"                       =>    {:referring_language_descriptions                 =>    :string_array},
+          "RefLanguageConfidence"                 =>    {:referring_language_confidences                  =>    :integer_array},
+          "RefLanguagePageRatios"                 =>    {:referring_language_page_ratios                  =>    :float_array},
+          "RefLanguageTotalPages"                 =>    {:referring_language_total_pages                  =>    :integer},
+          "TotalNonUniqueLinks"                   =>    {:total_non_unique_links                          =>    :integer},
+        }
+        
+        self.non_unique_link_types            =   {}
+        
+        self.non_unique_link_types_mappings   =   {
+          "NonUniqueLinkTypeHomepages"            =>    {:homepages                                       =>    :integer},
+          "NonUniqueLinkTypeIndirect"             =>    {:indirect                                        =>    :integer},
+          "NonUniqueLinkTypeDeleted"              =>    {:deleted                                         =>    :integer},
+          "NonUniqueLinkTypeNoFollow"             =>    {:no_follow                                       =>    :integer},
+          "NonUniqueLinkTypeProtocolHTTPS"        =>    {:https                                           =>    :integer},
+          "NonUniqueLinkTypeFrame"                =>    {:frame                                           =>    :integer},
+          "NonUniqueLinkTypeImageLink"            =>    {:image_link                                      =>    :integer},
+          "NonUniqueLinkTypeRedirect"             =>    {:redirect                                        =>    :integer},
+          "NonUniqueLinkTypeTextLink"             =>    {:text_link                                       =>    :integer},
+        }
+        
+        self.referring_domain_types           =   {}
+        
+        self.referring_domain_types_mappings  =   {
+          "RefDomainTypeLive"                     =>    {:live                                            =>    :integer},
+          "RefDomainTypeFollow"                   =>    {:follow                                          =>    :integer},
+          "RefDomainTypeHomepageLink"             =>    {:homepage_link                                   =>    :integer},
+          "RefDomainTypeDirect"                   =>    {:direct                                          =>    :integer},
+          "RefDomainTypeProtocolHTTPS"            =>    {:https                                           =>    :integer},
+        }
+        
+        self.hash_mappings                    =   {
+          /^NonUniqueLinkType/i                   =>  :non_unique_link_types,
+          /^RefDomainType/i                       =>  :referring_domain_types
+        }
+        
+        self.topical_trust_flows              =   {}
+                
+        parse_item_info
+      end
+      
+      def parse_item_info
+        self.data.each do |api_column, api_value|
+          column, value   =   parse_field(self.mappings, api_column, api_value)
+          self.send("#{column}=", value) if !column.nil? && !value.nil?
+        end
+        
+        parse_hashes
+        parse_topical_trust_flows
+        set_result_status
+        set_item_type
+      end
+      
+      def parse_hashes
+        self.data.each do |api_column, api_value|
+          self.hash_mappings.each do |regex, mappings_symbol|
+            if api_column =~ regex
+              column_mapping    =   self.send("#{mappings_symbol}_mappings".to_sym)
+              column, value     =   parse_field(column_mapping, api_column, api_value)
+              self.send(mappings_symbol)[column] = value if !column.nil? && !value.nil?
+            end
+          end
+        end
+      end
+      
+      def parse_topical_trust_flows
+        self.data.each do |api_column, api_value|
+          if api_column =~ /^TopicalTrustFlow_Topic_\d*/i
+            topic   =   api_value.to_s
+            index   =   api_column.match(/TopicalTrustFlow_Topic_(?<index>\d*)/i)[:index].to_i
+            value   =   self.data.fetch("TopicalTrustFlow_Value_#{index}", nil)
+            
+            self.topical_trust_flows[index] = {topic: topic, value: value.to_i} if !index.nil? && !topic.empty? && !value.nil?
+          end
+        end
+      end
+      
+      def parse_field(column_mapping, api_column, api_value)
+        column    =   nil
+        value     =   nil
+        
+        mapping   =   column_mapping.fetch(api_column, nil)
+        
+        mapping.each do |col, data_type|
+          column  =   col
+          value   =   convert_value(api_value.to_s, col, data_type)
+        end if mapping && !mapping.empty? && !api_value.to_s.empty?
+        
+        return column, value
+      end
+      
+      def convert_value(value, column, data_type)
+        return case data_type
+          when :string
+            value.to_s
+          when :integer
+            value.to_i
+          when :float
+            value.to_f
+          when :date
+            value.to_s
+          when :boolean
+            value.to_s.downcase.eql?("true")
+          when :string_array
+            value.to_s.include?(",") ? value.to_s.split(",").collect { |val| val.to_s } : [value.to_s]
+          when :integer_array
+            value.to_s.include?(",") ? value.to_s.split(",").collect { |val| val.to_i } : [value.to_s]
+          when :float_array
+            value.to_s.include?(",") ? value.to_s.split(",").collect { |val| val.to_f } : [value.to_s]
+        end
+      end
+      
+      def set_result_status
+        self.success          =   (self.result_code && self.result_code.downcase.eql?("ok"))
+        self.error_message    =   self.success ? "" : self.result_code
+      end
+      
+      def set_item_type
+        self.type = case self.type
+          when 1 then :root_domain
+          when 2 then :sub_domain
+          when 3 then :url
+        end
+      end
+
+    end
+
+  end
+end

data/lib/majestic/api/item_info_response.rb

@@ -0,0 +1,28 @@
+module Majestic
+  module Api
+    class ItemInfoResponse < Response
+      
+      def initialize(response)
+        super(response)
+        
+        raise_exceptions_if_necessary
+        parse_item_info_objects
+      end
+      
+      def raise_exceptions_if_necessary
+        case self.code
+          when 'InsufficientIndexItemInfoUnits'
+            raise Majestic::Api::InsufficientIndexItemInfoUnitsException.new(self.error_message)
+        end unless success?
+      end
+      
+      def parse_item_info_objects
+        self.parsed_items.each do |parsed_item|
+          item_info   =   Majestic::Api::ItemInfo.new(parsed_item)
+          self.items <<   item_info unless self.items.include?(item_info)
+        end if self.parsed_items && self.parsed_items.any?
+      end
+      
+    end
+  end
+end

data/lib/majestic/api/logger.rb

@@ -0,0 +1,14 @@
+module Majestic
+  module Api
+    module Logger
+
+      def log(level, message)
+        if (self.respond_to?(:verbose) && self.verbose)
+          (defined?(Rails) && Rails.logger) ? Rails.logger.send(level, message) : puts(message)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/majestic/api/railtie.rb

@@ -0,0 +1,12 @@
+require 'majestic/api'
+require 'rails'
+
+module Majestic
+  class Railtie < Rails::Railtie
+    
+    #rake_tasks do
+    #  Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |ext| load ext }
+    #end
+    
+  end
+end

data/lib/majestic/api/response.rb

@@ -0,0 +1,44 @@
+module Majestic
+  module Api
+    class Response
+      attr_accessor :response, :code, :success, :error_message, :full_error, :items, :parsed_items
+
+      def initialize(response = nil)
+        self.response             =   response
+        self.success              =   false
+        self.items                =   []
+        self.parsed_items         =   []
+
+        parse_response
+      end
+
+      def parse_response
+        if self.response.is_a?(Faraday::Response)
+          self.response           =   (self.response && self.response.body) ? self.response.body : nil
+          
+          if self.response
+            self.code             =   self.response.fetch("Code", "")
+            self.success          =   self.code.downcase.eql?("ok")
+            self.error_message    =   self.response.fetch("ErrorMessage", "")
+            self.full_error       =   self.response.fetch("FullError", "")
+          
+            if success?
+              self.parsed_items   =   self.response.fetch("DataTables", {}).fetch("Results", {}).fetch("Data", [])
+            end
+          end
+        end
+      end
+
+      def success?
+        self.success
+      end
+
+      def stacktrace
+        self.full_error
+      end
+
+    end
+
+  end
+end
+

data/lib/majestic/api/version.rb

@@ -0,0 +1,5 @@
+module Majestic
+  module Api
+    VERSION = "1.4.0"
+  end
+end

data/majestic-api.gemspec

@@ -0,0 +1,49 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "majestic/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "majestic-api"
+  spec.version       = Majestic::Api::VERSION
+  spec.authors       = ["Sebastian Johnsson"]
+  spec.email         = ["sebastian.johnsson@gmail.com"]
+
+  spec.summary       = %q{Majestic Ruby API Client}
+  spec.description   = %q{Ruby client to interact with Majestic's API}
+  spec.homepage      = "https://github.com/SebastianJ/majestic-api"
+  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["homepage_uri"]       =   spec.homepage
+    spec.metadata["source_code_uri"]    =  "https://github.com/SebastianJ/majestic-api"
+    spec.metadata["changelog_uri"]      =  "https://github.com/SebastianJ/majestic-api/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_dependency "faraday",                ">= 0.15.4"
+  spec.add_dependency "faraday_middleware",     ">= 0.13.1"
+
+  spec.add_development_dependency "bundler",    ">= 1.17"
+  spec.add_development_dependency "rake",       ">= 10.0"
+  spec.add_development_dependency "rspec",      ">= 3.0"
+  spec.add_development_dependency "vcr",        ">= 4.0"
+  spec.add_development_dependency "webmock",    ">= 3.5.1"
+  
+  spec.add_development_dependency "generator_spec", ">= 0.9.4"
+  
+  spec.add_development_dependency "pry",        "~> 0.12.2"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: majestic-api
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Sebastian Johnsson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: Ruby client to interact with Majestic's API
+email:
+- sebastian.johnsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- bin/console
+- bin/setup
+- lib/majestic/api.rb
+- lib/majestic/api/client.rb
+- lib/majestic/api/configuration.rb
+- lib/majestic/api/exceptions.rb
+- lib/majestic/api/extensions/string.rb
+- lib/majestic/api/item_info.rb
+- lib/majestic/api/item_info_response.rb
+- lib/majestic/api/logger.rb
+- lib/majestic/api/railtie.rb
+- lib/majestic/api/response.rb
+- lib/majestic/api/version.rb
+- majestic-api.gemspec
+homepage: https://github.com/SebastianJ/majestic-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SebastianJ/majestic-api
+  source_code_uri: https://github.com/SebastianJ/majestic-api
+  changelog_uri: https://github.com/SebastianJ/majestic-api/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Majestic Ruby API Client
+test_files: []