mozapi 0.1.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 148d77bd704d793a716ce47cf340794208251188
-  data.tar.gz: f6d3b010ac5a1a1818aab9d33b9178c706c0f5ab
+  metadata.gz: d76456421992f2c7fdb75f654d51129f23152d80
+  data.tar.gz: b6c0e6cb84f7189c14debd66789f6d1fbef82862
 SHA512:
-  metadata.gz: 479c9650261f6623f95b2cbceb12e7055e20227a7f0de162d0ac874bcc52db7432d6b9d2c18b495b8951e5802140dd1a3afa834289de4f498be176af195ba968
-  data.tar.gz: 1711fb33c946efe37362f399489b483c76dacd7f4897c25911b0d475d8e94163c42a355568bc9bb01f5fe8d662f1d485632093ec4f5dd06ce9843f4da457e7f6
+  metadata.gz: 2efc73b8089d5e37c5b678d89a7a8ba951e4ae507a83f635bf484956c641681a4bed4bb74c6b7e830e04a4562961869dfe3fb586ad76145cc5477fa1fd58f293
+  data.tar.gz: 2aa4844c8334b5ff8ee131079f88d7d355374e9228690e9dd467d4ae1d1e86e7c5f3276ae94053064109dad0c471cd304f5c57cda6be717fcdb15e93c05bb8ed

data/.gitignore

@@ -0,0 +1,4 @@
+
+
+
+*.gem

data/.project

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>mozapi</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.projects.webnature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    mozapi (1.0.0)
+      httparty (~> 0.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.2)
+    multi_xml (0.5.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mozapi!

data/README.md

@@ -0,0 +1,4 @@
+mozapi
+======
+
+Lightweight wrapper for the Mozscape API

data/lib/hash.rb

@@ -0,0 +1,6 @@
+class Hash
+  # very naive implementation of to_query
+  def to_query
+    map { |key, value| "#{key}=#{value}" }.join('&')
+  end
+end

data/lib/mozapi.rb

@@ -1,124 +1,6 @@
-require 'httparty'
-require 'open-uri'
-require 'openssl'
-require 'cgi'
-
-class Hash
-  # very naive implementation of to_query
-  def to_query
-    map { |key, value| "#{key}=#{value}" }.join('&')
-  end
-end
-
-
-class MozAPI
-  include HTTParty
-  base_uri 'http://lsapi.seomoz.com/linkscape'
-  
-  # there is a global limit on the Mozscape API that only lets you 
-  # retrieve 100,000 links for any URL
-  GLOBAL_LIMIT = 100000
-  
-  LIMIT = 100
-  
-  # defined 
-  
-  
-  URL                      = 4
-  # lt
-  ANCHOR_TEXT              = 4
-  # lnt
-  ANCHOR_TEXT_NORMALIZED   = 8
-  ROOT_DOMAIN              = 16
-  # uipl - not in the free version
-  LINKING_ROOT_DOMAINS     = 1024
-  # uid
-  LINKS                    = 2048
-  # upa
-  PAGE_AUTHORITY           = 34359738368
-  # pda
-  DOMAIN_AUTHORITY         = 68719476736
-  # pib
-  LINKING_C_BLOCKS         = 36028797018963968
-  
-  # URL + root_domain + page_authority + domain_authority
-  DEFAULT_SOURCE_COLS      = URL + ROOT_DOMAIN + PAGE_AUTHORITY + DOMAIN_AUTHORITY
-  # URL + root_domain
-  DEFAULT_TARGET_COLS      = URL + ROOT_DOMAIN
-  # anchor_text
-  DEFAULT_LINK_COLS        = ANCHOR_TEXT_NORMALIZED
-  # linking root domains + links + DA
-  DEFAULT_URL_METRICS_COLS = LINKING_ROOT_DOMAINS + 2048 + DOMAIN_AUTHORITY + LINKING_C_BLOCKS
-  
-  
-  def initialize(id, key)
-    @api_id = id
-    @api_key = key
-  end
-  
-  def links(target_url, options)
-    expires = expiration_time
-    
-    options = {
-      Sort: 'page_authority',
-      Filter: 'follow+external',
-      SourceCols: DEFAULT_SOURCE_COLS,
-      TargetCols: DEFAULT_TARGET_COLS,
-      LinkCols: DEFAULT_LINK_COLS,
-      AccessID: @api_id,
-      Expires: expires,
-      Signature: calculate_signature(expires),
-      Limit: LIMIT,
-      Offset: 0
-    }.merge(options)
-    
-    #puts "[MozAPI#links] options: #{options[:Offset]}"
-    req_url = "http://lsapi.seomoz.com/linkscape/links/#{URI::encode(target_url)}?#{options.to_query}" 
-
-    response = HTTParty.get(req_url, :headers => {"User-Agent" => 'node-linkscape (https://github.com/mjp/node-linkscape)'})
-    
-    raise "unknown endpoint for URL: #{req_url}" if 404 == response.code
-    json = JSON.parse response.body
-    puts "[MozAPI#links] links returned: #{json.size}"
-    
-    json
-  end
-  
-  #
-  def url_metrics(target_url, options = {})
-    
-    expires = expiration_time
-    
-    options = {
-      AccessID: @api_id,
-      Expires: expires,
-      Signature: calculate_signature(expires),
-      Cols: DEFAULT_URL_METRICS_COLS
-    }.merge(options)
-    
-    #puts "[MozAPI#links] options: #{options[:Offset]}"
-    req_url = "http://lsapi.seomoz.com/linkscape/url-metrics/#{URI::encode(target_url)}?#{options.to_query}" 
-
-    response = HTTParty.get(req_url, :headers => {"User-Agent" => 'node-linkscape (https://github.com/mjp/node-linkscape)'})
-    
-    raise "unknown endpoint for URL: #{req_url}" if 404 == response.code
-    json = JSON.parse response.body
-    puts "[MozAPI#links] links returned: #{json.size}"
-    
-    json
-  end
-  
-  
-  # private 
-  def calculate_signature(expires)
-    signature = "#{@api_id}\n#{expires}"
-    digest = OpenSSL::HMAC.digest('sha1', @api_key, signature)
-        
-    b64 = Digest::HMAC.base64digest(signature, @api_key, Digest::SHA1)
-    CGI::escape(Base64.encode64(digest).chomp)
-  end
-  
-  def expiration_time
-    (Time.now + 5 * 60).utc.to_i
-  end
-end
+require 'hash'
+require 'mozapi/version'
+require 'mozapi/cols'
+require 'mozapi/base'
+require 'mozapi/url_metrics'
+require 'mozapi/link_metrics'

data/lib/mozapi/base.rb

@@ -0,0 +1,32 @@
+require 'httparty'
+require 'open-uri'
+require 'openssl'
+require 'cgi'
+
+module MozAPI
+  class Base
+    include HTTParty
+    include MozAPI::Cols
+    base_uri 'http://lsapi.seomoz.com/linkscape/'
+    
+    attr_accessor :api_id, :api_key
+    
+    def initialize(id, key)
+      @api_id = id
+      @api_key = key
+    end
+    
+    protected 
+    def calculate_signature(expires)
+      signature = "#{@api_id}\n#{expires}"
+      digest = OpenSSL::HMAC.digest('sha1', @api_key, signature)
+          
+      b64 = Digest::HMAC.base64digest(signature, @api_key, Digest::SHA1)
+      CGI::escape(Base64.encode64(digest).chomp)
+    end
+    
+    def expiration_time
+      (Time.now + 5 * 60).utc.to_i
+    end
+  end
+end

data/lib/mozapi/cols.rb

@@ -0,0 +1,40 @@
+
+module MozAPI
+  module Cols
+    # there is a global limit on the Mozscape API that only lets you 
+    # retrieve 100,000 links for any URL
+    GLOBAL_LIMIT = 100000
+    
+    LIMIT = 100
+    
+    # defined 
+    
+    
+    URL                      = 4
+    # lt
+    ANCHOR_TEXT              = 4
+    # lnt
+    ANCHOR_TEXT_NORMALIZED   = 8
+    ROOT_DOMAIN              = 16
+    # uipl - not in the free version
+    LINKING_ROOT_DOMAINS     = 1024
+    # uid
+    LINKS                    = 2048
+    # upa
+    PAGE_AUTHORITY           = 34359738368
+    # pda
+    DOMAIN_AUTHORITY         = 68719476736
+    # pib
+    LINKING_C_BLOCKS         = 36028797018963968
+    
+    # URL + root_domain + page_authority + domain_authority
+    DEFAULT_SOURCE_COLS      = URL + ROOT_DOMAIN + PAGE_AUTHORITY + DOMAIN_AUTHORITY
+    # URL + root_domain
+    DEFAULT_TARGET_COLS      = URL + ROOT_DOMAIN
+    # anchor_text
+    DEFAULT_LINK_COLS        = ANCHOR_TEXT_NORMALIZED
+    # linking root domains + links + DA
+    DEFAULT_URL_METRICS_COLS = LINKING_ROOT_DOMAINS + LINKS + DOMAIN_AUTHORITY + LINKING_C_BLOCKS
+    
+  end
+end

data/lib/mozapi/link_metrics.rb

@@ -0,0 +1,38 @@
+require 'httparty'
+require 'open-uri'
+require 'openssl'
+require 'cgi'
+
+module MozAPI
+  class LinkMetrics < MozAPI::Base
+    
+    def get(target_url, options = {})
+      expires = expiration_time
+      
+      options = {
+        Sort: 'page_authority',
+        Filter: 'follow+external',
+        Scope: 'page_to_page',
+        SourceCols: DEFAULT_SOURCE_COLS,
+        TargetCols: DEFAULT_TARGET_COLS,
+        LinkCols: DEFAULT_LINK_COLS,
+        AccessID: api_id,
+        Expires: expires,
+        Signature: calculate_signature(expires),
+        Limit: LIMIT,
+        Offset: 0
+      }.merge(options)
+      
+      #puts "[MozAPI#links] options: #{options[:Offset]}"
+      req_url = "/links/#{URI::encode(target_url)}?#{options.to_query}" 
+  
+      response = self.class.get(req_url, :headers => {"User-Agent" => 'node-linkscape (https://github.com/mjp/node-linkscape)'})
+      
+      raise "unknown endpoint for URL: #{req_url}" if 404 == response.code
+      json = JSON.parse response.body
+      puts "[MozAPI#links] links returned: #{json.size}"
+      
+      json
+    end
+  end
+end

data/lib/mozapi/url_metrics.rb

@@ -0,0 +1,34 @@
+require 'httparty'
+require 'open-uri'
+require 'openssl'
+require 'cgi'
+
+module MozAPI
+  class URLMetrics < MozAPI::Base
+    
+    debug_output $stdout 
+    def get(target_url, options = {})
+      expires = expiration_time
+      
+      options = {
+        AccessID: api_id,
+        Expires: expires,
+        Signature: calculate_signature(expires),
+        Cols: DEFAULT_URL_METRICS_COLS
+      }.merge(options)
+      
+      
+      unless target_url.is_a? Array
+        req_url = "/url-metrics/#{URI::encode(target_url)}?#{options.to_query}"
+        
+        puts req_url
+        response = self.class.get(req_url, :headers => {"User-Agent" => 'node-linkscape (https://github.com/mjp/node-linkscape)'})
+        
+        raise "unknown endpoint for URL: #{req_url}" if 404 == response.code
+        json = JSON.parse response.body
+        puts "[MozAPI#links] links returned: #{json.size}"
+        json
+      end
+    end
+  end
+end

data/lib/mozapi/version.rb

@@ -0,0 +1,3 @@
+module MozAPI
+  VERSION = "1.0.0"
+end

data/mozapi.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mozapi/version'
+
+Gem::Specification.new do |s|
+  spec = s
+  s.name        = 'mozapi'
+  s.version     = MozAPI::VERSION
+  s.summary     = "A light-weight wrapper around the Mozscape API"
+  s.description = "MozAPI is a light-weight wrapper for the MozscapeAPI (http://moz.com/products/api). It currently supports parts of the 'links' endpoint"
+  s.authors     = ["Christoph Engelhardt"]
+  s.email       = 'christoph@it-engelhardt.de'
+  s.homepage    =
+    'https://github.com/yas4891/mozapi'
+  s.license       = 'MIT'
+  
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  s.add_dependency('httparty', '~> 0.13.1')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mozapi
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Christoph Engelhardt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -31,7 +31,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".project"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/hash.rb
 - lib/mozapi.rb
+- lib/mozapi/base.rb
+- lib/mozapi/cols.rb
+- lib/mozapi/link_metrics.rb
+- lib/mozapi/url_metrics.rb
+- lib/mozapi/version.rb
+- mozapi.gemspec
 homepage: https://github.com/yas4891/mozapi
 licenses:
 - MIT