majestic_seo_api 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 342c0fdbf0d19ed7d9661d5b1ca52c60520a4ef1
-  data.tar.gz: 74fad8728d5513457dac6994d89d533c5bc2bc6e
+  metadata.gz: 6291d530263ba1b47a87071630df73b58892bd73
+  data.tar.gz: 939767ba9245473fe9b7815b327f5832e259f961
 SHA512:
-  metadata.gz: 31411ee8fc70389765a348df20f97b60909dcc6f5819827ef1bf4a92b4e36b2dec5151b7e248e417f0a5823a6231900d592b869d55aac2fc328427846084c577
-  data.tar.gz: ff049c7d3533446d7c80113ce613672cc8d357119d5f0fd09fce5489703b03a3edfbc2aae249990f7c53dfc028744f767924f5a19b001623cb267d04efb36ac1
+  metadata.gz: 77b3d1b2ccdb47f58de18a91742ea21147bf6478d42902484ea4d2edaa57ddfdc11b72e10b916c8ffa105601d18fa5ac9462cb68d631aa3d632fb7deafb53a0a
+  data.tar.gz: 0b3c130fb3841a133c3794685868820c09284d46c7c360783eec1c7b34cecc55cda353118e6a66f863c86809f94cb567dc067c580bfded412f9b797b7de43fa8

data/.gitignore

@@ -0,0 +1,38 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## RUBYMINE
+.idea
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg/*
+
+## BUNDLER
+*.gem
+.bundle
+doc
+log
+Gemfile.lock
+.rvmrc
+.rbenv*
+
+## PROJECT::SPECIFIC
+.rbx
+
+## PROJECT::SPECIFIC
+lib/generators/templates/majestic_seo.yml
+spec/support/majestic_seo.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/Gemfile

@@ -1,8 +1,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-platforms :jruby do
-  gem "jruby-openssl", ">= 0.9"
-end
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
+# Specify your gem's dependencies in scrapely.gemspec
 gemspec
-

data/LICENSE.txt

@@ -1,50 +1,21 @@
-
-Version 0.9.3
-
-Copyright (c) 2011, Majestic-12 Ltd
-
-All rights reserved.
-
-
-
-Redistribution and use in source and binary forms, with or without
-
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright
-
-      notice, this list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above copyright
-
-      notice, this list of conditions and the following disclaimer in the
-
-      documentation and/or other materials provided with the distribution.
-
-    * Neither the name of the Majestic-12 Ltd nor the
-
-      names of its contributors may be used to endorse or promote products
-
-      derived from this software without specific prior written permission.
-
-
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-
-DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
-
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+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

@@ -1,74 +1,19 @@
-# Majestic SEO Ruby API Client #
+# Majestic Ruby API Client #
 
-**This is currently under heavy development (first released 2012-01-27). Get back to me if you run into any bugs.**
-
-This is a Ruby Api client/wrapper/connector intended to be used with [Majestic SEO's awesome API](http://developer-support.majesticseo.com/).
-
-Majestic SEO currently offers a client/connector over at [Connector Downloads](http://developer-support.majesticseo.com/connectors/downloads/) but this connector wasn't suitable for me because:
-
-* It wasn't gemified (thus requiring a bunch of hacking to incorporate it into every respective Rails-app)
-* Didn't have a config file with environment specific client settings (api key, api environment). I need to be able to use different api environments depending on the app environment
-* **Didn't work with JRuby** - this gem does (or well - on 1.6.6-head and 1.7-head).
-* Lacked test/spec coverage. The current test coverage isn't the best, but it's still better than nothing.
-
-It is based on the Majestic SEO connector but has pretty much been rewritten from scratch.
-
-The original script/test-files included now reside in script/. All of them haven't been completely upgraded yet, but they will be upgraded eventually.
+Client intended to be used with [Majestic's API](http://developer-support.majesticseo.com/).
 
 ## Installation ##
 ```
 gem install majestic_seo_api
 ```
 
-Using Gemfile:
-
+## Configuration ##
 ```
-gem "faraday_middleware", :git => 'git://github.com/Agiley/faraday_middleware.git'
-gem "majestic_seo_api"
+MajesticSeoApi.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
 ```
 
-Generate config file:
-
-```
-rails generate majestic_seo
-```
-
-## Tested on ##
-The specs pass on:
-
-* Ruby 1.9.2
-* Ruby 1.9.3
-* JRuby 1.6.6-head
-* JRuby 1.7-head
-
-*JRuby 1.6.5/1.6.5.1 does not work :(*
-
-## License ##
-Original Majestic SEO License:
-
----------
-
-Copyright (c) 2011, Majestic-12 Ltd
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-* Neither the name of the Majestic-12 Ltd nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
----------
-
+If you're using Rails, create an initializer in config/initializers/majestic.rb to configure the client globally in your app.

data/Rakefile

@@ -1,87 +1,6 @@
-## helper functions
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-begin
-  # Rspec 2.0
-  require 'rspec/core/rake_task'
-
-  desc 'Default: run specs'
-  task :default => :spec
-  RSpec::Core::RakeTask.new do |t|
-    t.pattern = "spec/**/*_spec.rb"
-  end
-
-  RSpec::Core::RakeTask.new('rcov') do |t|
-    t.pattern = "spec/**/*_spec.rb"
-    t.rcov = true
-    t.rcov_opts = ['--exclude', 'spec']
-  end
-
-rescue LoadError
-  puts "Rspec not available. Install it with: gem install rspec"
-end
-
-## release management tasks
-
-desc "Commit, create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{gem_file}"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc "Generate #{gemspec_file}"
-task :gemspec do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split(" # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| " #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = " s.files = %w[\n#{files}\n ]\n"
-  spec = [head, manifest, tail].join(" # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
+RSpec::Core::RakeTask.new(:spec)
 
+task :default => :spec

data/bin/console

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "majestic_seo_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__), "../spec/support/majestic_seo.yml")
+
+if File.exists?(cfg_path)
+  yaml                  =   YAML.load_file(cfg_path)["development"]
+
+  MajesticSeoApi.configure do |config|
+    config.environment  =   yaml.fetch("environment", :sandbox)
+    config.api_key      =   yaml.fetch("api_key", nil)
+    config.verbose      =   true
+  end
+end
+
+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_seo/api/client.rb

@@ -1,70 +1,17 @@
-
-=begin
-
-  Version 0.9.3
-
-  Copyright (c) 2011, Majestic-12 Ltd
-  All rights reserved.
-
-  Redistribution and use in source and binary forms, with or without
-  modification, are permitted provided that the following conditions are met:
-  1. Redistributions of source code must retain the above copyright
-  notice, this list of conditions and the following disclaimer.
-  2. Redistributions in binary form must reproduce the above copyright
-  notice, this list of conditions and the following disclaimer in the
-  documentation and/or other materials provided with the distribution.
-  3. Neither the name of the Majestic-12 Ltd nor the
-  names of its contributors may be used to endorse or promote products
-  derived from this software without specific prior written permission.
-
-  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-  DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
-  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-=end
-
-require 'uri'
-require 'cgi'
-require 'rubygems'
-require 'faraday_middleware'
-
 module MajesticSeo
   module Api
 
     class Client
-      attr_accessor :connection, :api_url, :config, :api_key, :environment, :verbose
+      attr_accessor :connection, :api_url
       include MajesticSeo::Api::Logger
 
-    	def initialize(options = {})
-    		set_config
-
-    		@api_key            =   options.fetch(:api_key,     self.config.fetch("api_key", nil))
-    		@environment        =   options.fetch(:environment, self.config.fetch("environment", :sandbox)).to_sym
-    		@verbose            =   options.fetch(:verbose,     false)
-
+    	def initialize
     		set_api_url
     		set_connection
     	end
-
-    	def set_config
-    	  env           = (defined?(Rails) && Rails.respond_to?(:env)) ? Rails.env : (ENV["RACK_ENV"] || 'development')
-
-    	  self.config   = YAML.load_file(File.join(Rails.root, "config/majestic_seo.yml"))[env] rescue nil
-        self.config ||= YAML.load_file(File.join(File.dirname(__FILE__), "../../generators/templates/majestic_seo.yml"))[env] rescue nil
-        self.config ||= YAML.load_file(File.join(File.dirname(__FILE__), "../../generators/templates/majestic_seo.template.yml"))[env] rescue nil
-        self.config ||= {}
-    	end
       
-      #TODO: Switch to the JSON API
-    	def set_api_url(format = :xml)
-        @api_url      =   case @environment.to_sym
+    	def set_api_url(format = :json)
+        self.api_url      =   case ::MajesticSeoApi.configuration.environment.to_sym
           when :sandbox     then "http://developer.majestic.com/api/#{format}"
           when :production  then "http://api.majestic.com/api/#{format}"
           else
@@ -73,11 +20,12 @@ module MajesticSeo
       end
 
     	def set_connection
-    	  @connection = Faraday.new(url: @api_url, ssl: {verify: false}) do |builder|
-          builder.request   :url_encoded
-          builder.request   :retry
-          builder.response  :logger if (@verbose)
-          builder.adapter   :net_http
+    	  self.connection = Faraday.new(url: self.api_url, ssl: {verify: false}) do |builder|
+          builder.request  :url_encoded
+          builder.request  :retry
+          builder.response :json
+          builder.response :logger if ::MajesticSeoApi.configuration.verbose
+          builder.adapter  :net_http
         end
     	end
 
@@ -97,6 +45,8 @@ module MajesticSeo
     	end
 
     	def get_top_back_links(url, parameters = {}, options = {})
+        raise "Not implemented yet!"
+        
         request_parameters                                  =     {}
         request_parameters['datasource']                    =     parameters.fetch(:data_source, "historic")
         request_parameters['URL']                           =     url
@@ -108,10 +58,10 @@ module MajesticSeo
         request_parameters["MaxSourceURLsPerRefDomain"]     =     parameters.fetch(:max_source_urls_per_ref_domain, -1)
         request_parameters["DebugForceQueue"]               =     parameters.fetch(:debug_force_queue, 0)
 
-        response    =   self.execute_command("GetTopBackLinks", request_parameters, options)
-        response    =   MajesticSeo::Api::TopBackLinksResponse.new(response)
+        #response    =   self.execute_command("GetTopBackLinks", request_parameters, options)
+        #response    =   MajesticSeo::Api::TopBackLinksResponse.new(response)
 
-        return response
+        #return response
     	end
 
     	# This method will execute the specified command as an api request.
@@ -119,7 +69,7 @@ module MajesticSeo
     	# '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, parameters = {}, options = {})
-    		request_parameters = parameters.merge({"app_api_key" => @api_key, "cmd" => name})
+    		request_parameters = parameters.merge({"app_api_key" => ::MajesticSeoApi.configuration.api_key, "cmd" => name})
     		self.execute_request(request_parameters, options)
     	end
 
@@ -129,7 +79,7 @@ module MajesticSeo
     	# '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, parameters = {}, options = {})
-    		request_parameters = parameters.merge({"accesstoken" => access_token, "cmd" => command_name, "privatekey" => @api_key})
+    		request_parameters = parameters.merge({"accesstoken" => access_token, "cmd" => command_name, "privatekey" => ::MajesticSeoApi.configuration.api_key})
     		self.execute_request(request_parameters, options)
     	end
 
@@ -143,14 +93,14 @@ module MajesticSeo
         begin
           log(:info, "[MajesticSeo::Api::Client] - Sending API Request to Majestic SEO. Parameters: #{parameters.inspect}. Options: #{options.inspect}")
           
-          response      =   @connection.get do |request|
-            request.params                    =   parameters  if (!parameters.empty?)
-            request.options                   =   options     if (!options.empty?)
+          response      =   self.connection.get do |request|
+            request.params                    =   parameters  if !parameters.empty?
+            request.options                   =   options     if !options.empty?
             request.options[:timeout]         =   timeout
             request.options[:open_timeout]    =   open_timeout
           end
         
-        rescue StandardError => e
+        rescue Faraday::Error => e
           log(:error, "[MajesticSeo::Api::Client] - Error occurred while trying to perform API-call with parameters: #{parameters.inspect}. Error Class: #{e.class.name}. Error Message: #{e.message}. Stacktrace: #{e.backtrace.join("\n")}")
           retries -= 1
           
@@ -167,4 +117,4 @@ module MajesticSeo
     end
 
   end
-end
+end