tixriss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3367b2fd6e1be04ddb6737ece0418d7f09f647a1
+  data.tar.gz: b9ec290c9d1ba60eaad19ed083efc7ca325b50e3
+SHA512:
+  metadata.gz: 64d932c5cba39505b85a113aff2e225f3f9d5dc6483d8df584462eb854a78945bb9270e20eeea50d48962ade0363789e9725bf6d535efef47d960e79e057421e
+  data.tar.gz: 6ffa2b9b8b532a98f99a4eb3a6a07fdced096ed92f709348084cb8c9fb1c2a9f30995ae077286e553e7b1893201eef6f70adf17bdfb35b99b42415ffd0804d27

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+tixriss

data/.ruby-version

@@ -0,0 +1 @@
+2.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - '2.0.0'
+  - '2.1.0'
+cache: bundler
+script:
+  - bundle exec rake test

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Carsten Zimmermann
+
+MIT License
+
+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,49 @@
+# Tixriss [![Build Status](https://travis-ci.org/Absolventa/tixriss.svg?branch=master)](https://travis-ci.org/Absolventa/tixriss)
+
+Tixriss is a simple Ruby library and command line interface to access Sistrix' links.list API.
+
+## Installation
+
+If you have a working Ruby installation you can install with:
+
+    $ gem install tixriss
+
+In the rare event that you would like to use the underlying
+Ruby classes in your application, add this to your Gemfile:
+
+```ruby
+gem 'tixriss'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Retrieve XML data and transform output to HTML:
+
+```shell
+tixriss --key <your api key> --domain <reqested domain with link data> --file report.html
+```
+
+To get a full list of available CLI options, type:
+
+```shell
+tixriss --help
+```
+
+## Changelog
+
+### HEAD (not yet released)
+
+### v0.1.0
+* Initial working prototype
+
+## Contributing
+
+1. Fork it ( https://github.com/Absolventa/tixriss/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+task spec: :test
+task default: :test

data/bin/tisriss

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'tixriss'
+
+options = {}
+option_parser = OptionParser.new { |opts|
+  opts.banner = "Usage: tisriss [options]"
+
+  opts.separator ""
+  opts.separator "Mandatory options:"
+
+  opts.on("-d", "--domain DOMAIN", "The requested domain name to get link data for") do |domain|
+    options[:domain] = domain
+  end
+
+  opts.on("-k", "--key KEY", "Your Sistrix API key") do |key|
+    options[:apikey] = key
+  end
+
+  opts.separator ""
+  opts.separator "Other options:"
+
+  opts.on("-f", "--file OUTPUTFILE", "Location for the generated report (Default: STDOUT)") do |file|
+    options[:file] = file.strip
+  end
+
+  opts.on("-i", "--input INPUTFILE", "Use INPUTFILE instead of making an API call") do |file|
+    options[:input] = file.strip
+  end
+
+  opts.on("-r", "--save-raw FILENAME", "Save API's XML response in FILENAME") do |file|
+    options[:source] = file.strip
+  end
+
+  opts.on_tail("-h", "--help", "Show this help message") do
+    puts opts
+  end
+}
+option_parser.parse!
+
+input = if filename = options[:input]
+          File.read(filename)
+        end
+
+if !input && options[:domain] && options[:apikey]
+  request = Tixriss::Request.new(domain: options[:domain], key: options[:apikey])
+  input = request.get
+end
+
+unless input
+  puts option_parser
+  exit 1
+end
+
+File.open(options[:source], 'w+'){ |f| f.write input } if options[:source]
+
+transformer = Tixriss::Transformer.new(input)
+
+if filename = options[:file]
+  File.open(filename, 'w+') { |f| f.write transformer.output }
+else
+  STDOUT.puts transformer.output
+end
+

data/lib/tixriss/request.rb

@@ -0,0 +1,25 @@
+module Tixriss
+  class Request
+    attr_reader :domain, :key
+
+    def initialize(domain: nil, key: nil)
+      @domain, @key = domain, key
+    end
+
+    def response
+      @response ||= get
+    end
+
+    def get
+      Net::HTTP.get uri
+    end
+
+    def uri
+      @uri ||= URI("http://api.sistrix.net/links.list?#{parameters}")
+    end
+
+    def parameters
+      "api_key=#{key}&domain=#{domain}"
+    end
+  end
+end

data/lib/tixriss/transformer.rb

@@ -0,0 +1,83 @@
+module Tixriss
+  class Transformer
+
+    class HTML < Struct.new(:xml)
+      def to_s
+        [header, body, footer].join "\n"
+      end
+
+      def rows
+        links.map do |row|
+          data = row.map { |cell| "<td>#{cell}</td>" }.join
+          "<tr>#{data}</tr>"
+        end
+      end
+
+      def links
+        rows = document.xpath('//response/answer/link').map(&:to_s)
+        rows.map do |row|
+          node = Nokogiri::XML(row)
+          url_from = node.xpath('//@url.from')
+          url_to   = node.xpath('//@url.to')
+          text     = node.xpath('//@text')
+
+          [url_from, url_to, text]
+        end
+      end
+
+      def document
+        @document ||= Nokogiri::XML(xml)
+      end
+
+      def body
+        <<-EOBODY
+<body>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>From</th>
+      <th>To</th>
+      <th>Text</th>
+    </tr>
+  </thead>
+  <tbody>
+    #{rows.join("\n")}
+  </tbody>
+</table>
+</body>
+EOBODY
+      end
+
+      def header
+        <<-EOHEADER
+<html>
+<head>
+  <title>Tixriss Report</title>
+  <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet"/>
+</head>
+EOHEADER
+      end
+
+      def footer
+        '</html>'
+      end
+    end
+
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+    end
+
+    def output
+      HTML.new(input).to_s
+    end
+
+    private
+
+    def output_file
+      @output_file ||= File.new(output, 'w+')
+    end
+
+  end
+end

data/lib/tixriss/version.rb

@@ -0,0 +1,3 @@
+module Tixriss
+  VERSION = "0.1.0"
+end

data/lib/tixriss.rb

@@ -0,0 +1,7 @@
+require "tixriss/version"
+require 'nokogiri'
+
+module Tixriss
+  autoload :Request,     'tixriss/request'
+  autoload :Transformer, 'tixriss/transformer'
+end

data/spec/command_line_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'open3'
+
+describe 'the command line interface' do
+  let(:inputfile) { File.join File.dirname(File.expand_path(__FILE__)), 'response.xml' }
+  let(:response)  { File.read(inputfile) }
+
+  before do
+    stub_request(:get, "http://api.sistrix.net/*").to_return(body: response)
+  end
+
+  context 'called with insuffient arguments' do
+    it 'displays usage information' do
+      output, status = run_cli
+      status.wont_equal 0
+      output.must_match(/Usage/)
+    end
+  end
+
+  context 'with persisted input' do
+    it 'transforms the input to stdout' do
+      output, status = run_cli(args: ["--input #{inputfile}"])
+
+      output.must_match(/\A<html>/)
+    end
+
+    it 'writes transformed data to file' do
+      outputfile = "./tix.html"
+
+      output, status = run_cli(args: ["--input #{inputfile}", "--file #{outputfile}"])
+
+      output.must_equal ''
+      File.exists?(outputfile).must_equal true
+      File.read(outputfile).must_match(/\A<html>/)
+
+      FileUtils.rm outputfile
+    end
+
+    it 'allows piping of input data' do
+      skip 'Feature not yet implemented'
+    end
+
+  end
+
+  def run_cli(input = '', args: [])
+    output, status = Open3.capture2("./bin/tisriss #{args.join(' ')}", stdin_data: '')
+    [output, status.to_i]
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Tixriss::Request do
+  let(:api_key)  { SecureRandom.hex 8 }
+  let(:domain)   { 'absolventa.de' }
+  let(:response) { File.read(File.join File.dirname(File.expand_path(__FILE__)), 'response.xml') }
+
+  subject { Tixriss::Request.new domain: domain, key: api_key }
+
+  describe 'its constructor' do
+    it 'sets the api key' do
+      subject = Tixriss::Request.new key: api_key
+      subject.key.must_equal api_key
+    end
+
+    it 'sets the domain' do
+      subject = Tixriss::Request.new domain: domain
+      subject.domain.must_equal domain
+    end
+  end
+
+  describe '#get' do
+    before do
+      get_parameters = "api_key=#{api_key}&domain=#{domain}"
+      stub_request(:get, "http://api.sistrix.net/links.list?#{get_parameters}").
+        to_return(body: response)
+    end
+
+    it 'returns the xml on success' do
+      subject.get.must_equal response
+    end
+
+    it 'caches the result as #response' do
+      subject.response.must_equal response
+      WebMock.reset! # Makes webmock fail hard if another request is made
+      subject.response.must_equal response
+    end
+
+  end
+
+end

data/spec/response.xml

@@ -0,0 +1,9 @@
+<response>
+  <api_key />
+  <method>links.list</method>
+  <answer>
+    <link url.from="http://www.google.de/" text="What a job platform!" url.to="http://www.absolventa.de/"/>
+    <link url.from="http://www.yahoo.de/" text="Look no further" url.to="http://www.absolventa.de/"/>
+  </answer>
+  <credits used="2" />
+</response>

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'tixriss'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest-spec-context'
+require 'webmock/minitest'

data/spec/transformer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Tixriss::Transformer do
+  let(:input)  { File.read(File.join File.dirname(File.expand_path(__FILE__)), 'response.xml') }
+
+  subject { Tixriss::Transformer.new input }
+
+  describe 'its constructor' do
+    it 'sets the input file' do
+      subject = Tixriss::Transformer.new input
+      subject.input.must_equal input
+    end
+  end
+
+  describe '#write' do
+    it 'has an html table' do
+      html = Nokogiri::HTML(subject.output)
+
+      html.css('table thead tr').size.must_equal 1
+      html.css('table tbody tr').size.must_equal 2
+    end
+  end
+end

data/tixriss.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tixriss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tixriss"
+  spec.version       = Tixriss::VERSION
+  spec.authors       = ["Carsten Zimmermann"]
+  spec.email         = ["cz@aegisnet.de"]
+  spec.summary       = %q{Simple Ruby library and command line interface to access Sistrix' links.list API}
+  spec.description   = %q{Retrieves links.list data and allows processing/transformation}
+  spec.homepage      = "https://github.com/Absolventa/tixriss"
+  spec.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"]
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-spec-context"
+  spec.add_development_dependency "minitest-implicit-subject"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: tixriss
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carsten Zimmermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-implicit-subject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retrieves links.list data and allows processing/transformation
+email:
+- cz@aegisnet.de
+executables:
+- tisriss
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tisriss
+- lib/tixriss.rb
+- lib/tixriss/request.rb
+- lib/tixriss/transformer.rb
+- lib/tixriss/version.rb
+- spec/command_line_spec.rb
+- spec/request_spec.rb
+- spec/response.xml
+- spec/spec_helper.rb
+- spec/transformer_spec.rb
+- tixriss.gemspec
+homepage: https://github.com/Absolventa/tixriss
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple Ruby library and command line interface to access Sistrix' links.list
+  API
+test_files:
+- spec/command_line_spec.rb
+- spec/request_spec.rb
+- spec/response.xml
+- spec/spec_helper.rb
+- spec/transformer_spec.rb