debmirrorapi 0.1.2

data/README.md

@@ -0,0 +1,18 @@
+Debmirror-API
+=============
+
+Documentation of methods is done in rspec - simply run `bundle exec rspec -f d` to see supported methods.
+
+You can also do `bundle exec rackup -p 9292` and open <http://localhost:9292> in your browser.
+
+For a todo list, see [TODO.md](TODO.md)
+
+Continously built on ruby 1.8.7 and ruby 1.9.3 on Travis-CI: [![Build Status](https://travis-ci.org/Jimdo/debmirror-api.png?branch=master)](https://travis-ci.org/Jimdo/debmirror-api)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rspec/core/rake_task'
+
+
+desc "run specs"
+RSpec::Core::RakeTask.new
+
+desc "run api"
+task :run => "Gemfile.lock" do
+  require File.join(File.dirname(__FILE__), 'debmirrorapi.rb')
+  DebmirrorApi.run!
+end
+
+file "Gemfile.lock" => "Gemfile" do
+  sh "bundle && touch Gemfile.lock"
+end

data/TODO.md

@@ -0,0 +1,10 @@
+ * split up production/development environment
+ * add configuration for hardcoded paths
+ * check if stubbing in tests or full repository as fixture in tests is the thing to do
+ * for next version
+  * add auth for post/patch
+  * add post method to create new tags
+  * add search
+  * add diff method to check changes between tags (maybe in v1 release!)
+  * somewhen add method to parse changelog and give you detailed update information
+  * more detailed responses, like url of resource, modified date of tage etc.

data/bin/debmirrorapi

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require 'debmirrorapi'
+
+DebmirrorApi.run!

data/config.ru

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+require "#{File.dirname(__FILE__)}/debmirrorapi"
+require "#{File.dirname(__FILE__)}/lib/debmirrorapihelpers"
+run DebmirrorApi

data/lib/debmirrorapi.rb

@@ -0,0 +1,123 @@
+require 'sinatra'
+require 'sinatra/croon'
+require 'json'
+require 'debmirrorapihelpers'
+
+class DebmirrorApi < Sinatra::Base
+  register Sinatra::Croon
+
+  helpers DebMirrorApi::Helpers
+
+# GET existing mirrors
+#
+# @request GET /mirrors
+#
+# @response
+#   "["deb.theforeman.org/","ftp.uk.debian.org/debian"]"
+  get '/mirrors' do
+    content_type :json
+    if mirror_list
+      mirror_list.to_json
+    else
+      body "file not found ('/var/lib/debmirror/mirror.index')".to_json
+      status 500
+    end
+  end
+
+# GET existing dists
+#
+# @request GET /dists/<mirror>
+# @request GET /dists/ftp.uk.debian.org/debian
+#
+# @response
+# "[\"squeeze\",\"wheezy\",\"sid\"]"
+  get '/dists/*' do
+    content_type :json
+    requested_mirror = params[:splat][0]
+    if mirror_list.include?(requested_mirror)
+      dists_dir = File.join("/var/lib/debmirror/", requested_mirror, "dists")
+      File.directory?(dists_dir) ? ((Dir.entries dists_dir).delete_if { |dist| dist == '.' || dist == '..' || File.symlink?(File.join(dists_dir, dist)) }).to_json : 404
+    else
+      405
+    end
+  end
+
+  # GET tags of a dist
+  #
+  # @request GET /tags/repo.percona.com/apt/dist/squeeze
+  #
+  # @response
+  # "{\"prod\":\"0\",\"prod-unstaged\":\"0\",\"dev\":\"5\",\"stable\":\"0\",\"latest\":\"17\"}"
+  get '/tags/*/dist/*' do
+    content_type :json
+    requested_mirror = params[:splat][0]
+    requested_dist = params[:splat][1]
+    if mirror_list.include?(requested_mirror) and requested_dist !=~ /\/..\//
+      tag_dir = File.join("/var/lib/debmirror/", requested_mirror, "dists", requested_dist)
+      response = {}
+      if File.directory?(tag_dir)
+        links = ((Dir.entries tag_dir).delete_if { |tag| tag == '.' || tag == '..' || !File.symlink?(File.join(tag_dir, tag)) })
+        links.each do |link|
+          response[link] = File.readlink(File.join(tag_dir,link))
+        end
+        response.to_json
+      else
+        404
+      end
+    else
+      405
+    end
+  end
+
+  # PATCH tags of a dist to version
+  #
+  # @request PATCH /tag/repo.percona.com/apt/dist/squeeze/stable
+  # version=4
+  #
+  # @response
+  # "{\"prod\":\"0\",\"prod-unstaged\":\"0\",\"dev\":\"5\",\"stable\":\"4\",\"latest\":\"17\"}"
+  patch '/tag/*/dist/*/*' do
+    content_type :json
+    requested_mirror = params[:splat][0]
+    requested_dist = params[:splat][1]
+    requested_tag = params[:splat][2]
+    if params['version'] =~ /\d+/
+      requested_tag_version = params['version']
+    else
+      body 'missing version in patch data'.to_json
+      halt 400
+    end
+    requested_tag_file = File.join("/var/lib/debmirror/", requested_mirror, "dists", requested_dist, requested_tag)
+    tag_dir = File.join("/var/lib/debmirror/", requested_mirror, "dists", requested_dist)
+    if mirror_list.include?(requested_mirror) and requested_dist !=~ /\/..\// and File.symlink?(requested_tag_file)
+      requested_tag_version_file = File.join("/var/lib/debmirror/", requested_mirror, "dists", requested_dist, requested_tag_version)
+      if File.exists?(requested_tag_version_file) and not File.symlink?(requested_tag_version_file)
+        File.link(requested_tag_version_file, requested_tag_file)
+        response = {}
+        links = ((Dir.entries tag_dir).delete_if { |tag| tag == '.' || tag == '..' || !File.symlink?(File.join(tag_dir, tag)) })
+        links.each do |link|
+          response[link] = File.readlink(File.join(tag_dir,link))
+        end
+        response.to_json
+      else
+        halt 405
+      end
+    else
+      404
+    end
+  end
+
+
+  # GET something that is not yet implemented
+  # @request GET /blubbi
+  #
+  # @response
+  # "{\"method not implemented\"}"
+  # status 501
+  get '/*' do
+    content_type :json
+    body 'method not implemented'.to_json
+    status 501
+  end
+
+end

data/lib/debmirrorapihelpers.rb

@@ -0,0 +1,19 @@
+module DebMirrorApi
+  module Helpers
+
+    def mirror_list
+      if File.file?('/var/lib/debmirror/mirror.index')
+        list = []
+        File.readlines('/var/lib/debmirror/mirror.index').each do |mirror|
+          list.push(mirror.chomp())
+        end
+        list
+      else
+        false
+      end
+    end
+
+  end
+
+end
+

data/spec/api_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+
+describe "Debmirror-API" do
+
+  context "mirrors" do
+
+    it "should respond to GET /mirrors" do
+      app.class_eval { helpers {
+        def mirror_list;
+          return ["deb.theforeman.org/", "ftp.uk.debian.org/debian", "archive.debian.org/debian-archive/debian", "repo.percona.com/apt"];
+        end } }
+      get '/mirrors'
+      last_response.should be_ok
+      last_response.status.should == 200
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      parsed_body = JSON.parse(last_response.body)
+      parsed_body.should include('deb.theforeman.org/', 'ftp.uk.debian.org/debian')
+    end
+
+    it "should respond with empty set if mirror.index is empty to GET /mirrors" do
+      app.class_eval { helpers {
+        def mirror_list;
+          return [];
+        end } }
+      get '/mirrors'
+      last_response.should be_ok
+      last_response.status.should == 200
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      last_response.body.should eq([].to_json)
+    end
+
+    it "should respond with an internal server error if mirror.index is missing" do
+      app.class_eval { helpers {
+        def mirror_list;
+          return false;
+        end } }
+      get '/mirrors'
+      last_response.should_not be_ok
+      last_response.status.should == 500
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      last_response.body.should eq("file not found ('/var/lib/debmirror/mirror.index')".to_json)
+    end
+
+  end
+
+  context "dists" do
+
+    before (:each) do
+      app.class_eval {
+        helpers {
+          def mirror_list;
+            return ["deb.theforeman.org/", "ftp.uk.debian.org/debian", "archive.debian.org/debian-archive/debian", "repo.percona.com/apt"];
+          end
+        }
+      }
+    end
+
+    it "should respond to GET /dists/deb.theforeman.org/" do
+      Dir.stub(:entries).with('/var/lib/debmirror/deb.theforeman.org/dists') { [".", "..", "stable"] }
+      File.stub(:directory?).with('/var/lib/debmirror/deb.theforeman.org/dists') { true }
+      get '/dists/deb.theforeman.org/'
+      last_response.should be_ok
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      last_response.should match(['stable'].to_json)
+    end
+
+    it "should respond to GET /dists/ftp.uk.debian.org/debian" do
+      Dir.stub(:entries).with('/var/lib/debmirror/ftp.uk.debian.org/debian/dists') { [".", "..", "squeeze", "wheezy", "sid", "unstable", "stable", "testing"] }
+      File.stub(:directory?).with('/var/lib/debmirror/ftp.uk.debian.org/debian/dists') { true }
+      File.stub(:symlink?) { false }
+      File.stub(:symlink?).with(%r{^/var/lib/debmirror/ftp.uk.debian.org/debian/dists/(unstable|testing|stable)$}) { true }
+      get '/dists/ftp.uk.debian.org/debian'
+      last_response.should be_ok
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      last_response.body.should eq(['squeeze', 'wheezy', 'sid'].to_json)
+    end
+
+    it "should respond to GET /dists/archive.debian.org/debian-archive/debian" do
+      Dir.stub(:entries).with('/var/lib/debmirror/archive.debian.org/debian-archive/debian/dists') { [".", "..", "lenny", "oldstable"] }
+      File.stub(:directory?).with('/var/lib/debmirror/archive.debian.org/debian-archive/debian/dists') { true }
+      File.stub(:symlink?) { false }
+      File.stub(:symlink?).with('/var/lib/debmirror/archive.debian.org/debian-archive/debian/dists/oldstable') { true }
+      get '/dists/archive.debian.org/debian-archive/debian'
+      last_response.should be_ok
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      last_response.body.should eq(['lenny'].to_json)
+    end
+
+    it "should send 405 to GET /dists/some.host.that.does.not.exist/" do
+      get '/dists/some.host.that.does.not.exist/'
+      last_response.status.should == 405
+    end
+
+  end
+
+  context "tags" do
+
+    before (:each) do
+      app.class_eval {
+        helpers {
+          def mirror_list;
+            return ["deb.theforeman.org/", "ftp.uk.debian.org/debian", "archive.debian.org/debian-archive/debian", "repo.percona.com/apt"];
+          end
+        }
+      }
+      File.stub(:directory?).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze') { true }
+      Dir.stub(:entries).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze') { [".", "..", "0", "main", "1", "prod", "prod-unstaged", "dev", "stable", "2", "latest", "3", "4", "11", "Release", "5", "6", "15", "Release.gpg", "7", "8", "9", "10", "12", "13", "14", "16", "17"] }
+      File.stub(:symlink?) { false }
+      File.stub(:symlink?).with(%r{^/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/(latest|dev|stable|prod|prod-unstaged)$}) { true }
+      File.stub(:readlink) { "0" }
+      File.stub(:readlink).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/latest') { "17" }
+      File.stub(:readlink).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/dev') { "5" }
+    end
+
+    it "should respond to GET /tags/repo.percona.com/apt/dists/squeeze" do
+      get '/tags/repo.percona.com/apt/dist/squeeze'
+      last_response.should be_ok
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      parsed_body = JSON.parse(last_response.body)
+      parsed_body.should eql({'dev' => '5', 'latest' => '17', 'prod' => '0', 'prod-unstaged' => '0', 'stable' => '0'})
+    end
+
+    #we don't need to test this, it is fixed in framework, see https://groups.google.com/forum/#!msg/sinatrarb/6Vp3JQd-vzM/LjGsFVspjScJ
+    it "should respond with a method not allowed error to GET /tags/repo.percona.com/apt/dists/../../../../../etc/passwd" do
+      get '/tags/repo.percona.com/apt/dist/../../../../../etc/passwd'
+      #last_response.should_not be_ok
+      #last_response.status.should == 405
+    end
+
+    it "should respond with a 404 to a not existing tag (e.g. GET /tags/repo.percona.com/apt/dists/toystory)" do
+      File.stub(:directory?).with('/var/lib/debmirror/repo.percona.com/apt/dists/toystory') { false }
+      get '/tags/repo.percona.com/apt/dist/toystory'
+      last_response.should_not be_ok
+      last_response.status.should == 404
+    end
+
+    it "should respond with method not allowed to a not existing repo (e.g. GET /tags/bullshitrepo/dists/stable" do
+      get '/tags/bullshitrepo/dist/stable'
+      last_response.should_not be_ok
+      last_response.status.should == 405
+    end
+
+  end
+
+  context "update tag" do
+
+    before (:each) do
+      app.class_eval {
+        helpers {
+          def mirror_list;
+            return ["deb.theforeman.org/", "ftp.uk.debian.org/debian", "archive.debian.org/debian-archive/debian", "repo.percona.com/apt"];
+          end
+        }
+      }
+      File.stub(:directory?).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze') { true }
+      Dir.stub(:entries).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze') { [".", "..", "0", "main", "1", "prod", "prod-unstaged", "dev", "stable", "2", "latest", "3", "4", "11", "Release", "5", "6", "15", "Release.gpg", "7", "8", "9", "10", "12", "13", "14", "16", "17"] }
+      File.stub(:symlink?) { false }
+      File.stub(:symlink?).with(%r{^/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/(latest|dev|stable|prod|prod-unstaged)$}) { true }
+      File.stub(:symlink?).with(%r{^/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/\d+$}) { false }
+      File.stub(:exists?).with(%r{^/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/\d+$}) { true }
+      File.stub(:readlink) { "0" }
+      File.stub(:readlink).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/latest') { "17" }
+      File.stub(:readlink).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/dev') { "5" }
+      File.stub(:link).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/4','/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/stable') { 0 }
+      File.stub(:readlink).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/stable') { "4" }
+
+    end
+
+    it "should update a tag to a defined version (e.g. PATCH /tags/repo.percona.com/apt/dists/squeeze/stable" do
+      patch '/tag/repo.percona.com/apt/dist/squeeze/stable', :version => 4
+      last_response.should be_ok
+      last_response.status.should == 200
+      parsed_body = JSON.parse(last_response.body)
+      parsed_body.should eql({'dev' => '5', 'latest' => '17', 'prod' => '0', 'prod-unstaged' => '0', 'stable' => '4'})
+    end
+
+    it "should respond with method not allowed if version does not exist" do
+      File.stub(:exists?).with('/var/lib/debmirror/repo.percona.com/apt/dists/squeeze/20') { false }
+      patch '/tag/repo.percona.com/apt/dist/squeeze/stable', :version => 20
+      last_response.should_not be_ok
+      last_response.status.should == 405
+    end
+
+    it "should respond with 404 if release_tag is not a valid tag" do
+      patch '/tag/repo.percona.com/apt/dist/squeeze/bullshit', :version => 4
+      last_response.should_not be_ok
+      last_response.status.should == 404
+    end
+
+    it "should respond with 404 if mirror does not exist" do
+      patch '/tag/bullshitrepo/dist/squeeze/stable', :version => 4
+      last_response.should_not be_ok
+      last_response.status.should == 404
+    end
+
+    it "should respond with 400 if version is empty" do
+      patch '/tag/repo.percona.com/apt/dist/squeeze/stable'
+      last_response.should_not be_ok
+      last_response.status.should == 400
+      last_response.body.should eq('missing version in patch data'.to_json)
+    end
+
+  end
+
+  context "request not implemented resource" do
+    it "should return not implemented httpcode and message" do
+      get '/something'
+      last_response.should_not be_ok
+      last_response.content_type.should eq('application/json;charset=utf-8')
+      last_response.body.should eq('method not implemented'.to_json)
+      last_response.status.should == 501
+    end
+  end
+
+  context "croon should generate valid documentation" do
+    it "should return readable documentation" do
+      get '/docs'
+      last_response.should be_ok
+      last_response.content_type.should eq('text/html;charset=utf-8')
+      last_response.body.should =~ /API Documentation/
+      last_response.status.should == 200
+    end
+  end
+
+end

data/spec/debmirrorapihelpers_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class Helper
+  include DebMirrorApi::Helpers
+end
+
+describe "DebmirrorApi::Helpers" do
+
+  before(:all) do
+    @helper = Helper.new
+
+    @mirror_index = File.readlines('spec/fixtures/mirror.index')
+  end
+
+  it "should return a mirror list" do
+    File.stub(:file?).with('/var/lib/debmirror/mirror.index') { true }
+    File.stub(:readlines).with('/var/lib/debmirror/mirror.index') { @mirror_index }
+    @helper.mirror_list.include?("repo.percona.com/apt/debian/dists/squeeze").should == true
+    @helper.mirror_list.include?("ftp.uk.debian.org/debian").should == true
+    @helper.mirror_list.include?("apt.newrelic.com/debian").should == true
+  end
+
+  it "should return false if no mirror.index is present" do
+    File.stub(:file?).with('/var/lib/debmirror/mirror.index') { false }
+    @helper.mirror_list.should == false
+  end
+
+  it "should return empty list if no lines present in mirror.index" do
+    File.stub(:file?).with('/var/lib/debmirror/mirror.index') { true }
+    File.stub(:readlines).with('/var/lib/debmirror/mirror.index') { [] }
+    @helper.mirror_list.should eql([])
+  end
+
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: debmirrorapi
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Lars Fronius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-croon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'API to provide an interface to debmirror.
+
+  It provides methods like get mirrors, dists, tags of your mirror and update already
+  created tags.
+
+'
+email: l.fronius@googlemail.com
+executables:
+- debmirrorapi
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- TODO.md
+- bin/debmirrorapi
+- lib/debmirrorapi.rb
+- lib/debmirrorapihelpers.rb
+- config.ru
+- spec/api_spec.rb
+- spec/debmirrorapihelpers_spec.rb
+homepage: http://github.com/Jimdo/debmirror-api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple API to provide an interface to debmirror.
+test_files:
+- spec/api_spec.rb
+- spec/debmirrorapihelpers_spec.rb