certificate-factory 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTM0N2U0ZmU0YzkwMThiMzFlYTc4MGUyYzZhNmQwOWFjNTVhZTBhYQ==
+  data.tar.gz: !binary |-
+    ZWMzM2MyNTM3ZWUzMDI4NmU5YzcwMTY1Yzc0N2EwNjQwNjhjYTU1Ng==
+SHA512:
+  metadata.gz: !binary |-
+    NzY0MGU4MzQ1ZDA0NmRkZjA1ZWI5Y2M3YWZlMDVlNWE0NWZiY2U3OTRjNmRm
+    ZTlkODA0YjQ1NTBjNDg0Mjg1MDgyOTM4N2Y2OTI4NzdmNjIyNjFlMTcwNDlh
+    YjlkMTJlNzkyMGM0ZGU1YWU5MWY3NDYzZTY0ODI4Njg4NWQ1NDU=
+  data.tar.gz: !binary |-
+    MGY0ZjYwNTliNzM3YWEyOTU5MzNjOGY3ZTViMDE5MDcyNTY0NTg3NGE0MWMz
+    YjBmNzdmN2U5YzgwYWNkMTFhMWNlNzg0YmVkZWRjMzk2ZDU1MjJlNGVjODYx
+    MjliYTJlNzg0ODc2YjU2MzEzNTdmNzVlYWUyMGQ5ZTZmYjkwMjI=

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/install.log
+coverage
+.env

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+- 2.3.1
+env:
+  global:
+  - BASE_URI='http://open-data-certificate.dev'
+  - secure: w1kS3tl+NK92wmvzdgLelfL8JI1CXyFunVJUJHwpN/evGDGrLxxXiCHP5tLYh/LQ1LuuzHLjLSwUHovRpDVFwS6eP0OOxDxKECIAWb5H2TORKl+70G4H3JRTkOwh9LhbpE6X/3d9za+uSujtXhuYRLZ4cifEigbHfclOqywr92s=
+  - secure: mIPq3Xf91/IC2t2s3uGo1hVXu/nwjVia9cKtA00Kfhxkrp8M3hBzpFtGKuhj5HARkGozpEkBS0jPU3MK93pGHCY8PzhuUAXd0Cpaek59CGfcRNf2TD95z0SrL+HoD9kagvAV9M10L9x5hqEv/lKCHh2S8qxrUbvy9TIdrZyz9aE=
+  - secure: T89jTDvzYTgBwJjwjc+Wk1+Mhbh9Orz35LaPCcw3zZ9GIpnYS6FLnMBSf9UrZAYR7ZHJf8vpoPtcVnEBPIORtMImPPJ7TBxIK3pEwzrBMnUBWkP+3BCvJRESFn1mkSePhpTNLjrLYXx8GL+t4yoZKqPuzGWM9rTltbTOzgeD1Hg=
+deploy:
+  provider: rubygems
+  api_key:
+    secure: y8U533/c1vC7oKISdh/C2MVU1nTVq6u85Pz2TaGyIdsOkXaOeMeRMSsyoZkNxY1dO/qMRb790YpSZbHSaAq/y7+v6Z42AFn64R0krRjfA5y/+3hqEIr+Kf5UUk/Q29KHerWVxHMvboMpKP30PwaFtE7MUEUqscqfTUFQFi6TutA=
+  gem: certificate-factory
+  on:
+    tags: true
+    repo: theodi/certificate-factory

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    certificate-factory (0.1.0)
+      dotenv
+      httparty
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    backports (3.6.8)
+    coderay (1.1.1)
+    colorize (0.7.7)
+    coveralls (0.8.14)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    dotenv (2.1.1)
+    ethon (0.9.0)
+      ffi (>= 1.3.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    ffi (1.9.13)
+    gh (0.14.0)
+      addressable
+      backports
+      faraday (~> 0.8)
+      multi_json (~> 1.0)
+      net-http-persistent (>= 2.7)
+      net-http-pipeline
+    git (1.3.0)
+    github_api (0.14.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2
+    github_changelog_generator (1.9.0)
+      colorize (~> 0.7)
+      github_api (~> 0.12)
+    hashdiff (0.3.0)
+    hashie (3.4.4)
+    henry (0.1.3)
+      git (~> 1.3)
+      github_api (~> 0.13)
+      github_changelog_generator (= 1.9.0)
+      thor (~> 0.19.1)
+      travis (~> 1.8.2)
+    highline (1.7.8)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    jwt (1.5.1)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    method_source (0.8.2)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    net-http-persistent (2.9.4)
+    net-http-pipeline (1.0.1)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    pusher-client (0.6.2)
+      json
+      websocket (~> 1.0)
+    rack (2.0.1)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    travis (1.8.2)
+      backports
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9, >= 0.9.1)
+      gh (~> 0.13)
+      highline (~> 1.6)
+      launchy (~> 2.1)
+      pusher-client (~> 0.4)
+      typhoeus (~> 0.6, >= 0.6.8)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    websocket (1.2.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  certificate-factory!
+  coveralls
+  henry
+  pry
+  pry-remote
+  rspec
+  simplecov
+  simplecov-rcov
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.md

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+---------------------
+
+Copyright (c) 2014 The Open Data Institute
+
+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,54 @@
+[![Build Status](http://img.shields.io/travis/theodi/certificate-factory.svg?style=flat-square)](https://travis-ci.org/theodi/certificate-factory)
+[![Dependency CI](http://dependencyci.com/github/theodi/certificate-factory/badge?style=flat-square)](http://dependencyci.com/github/theodi/certificate-factory)
+[![Coverage Status](http://img.shields.io/coveralls/theodi/certificate-factory.svg?style=flat-square)](https://coveralls.io/r/theodi/certificate-factory)
+[![Code Climate](http://img.shields.io/codeclimate/github/theodi/certificate-factory.svg?style=flat-square)](https://codeclimate.com/github/theodi/certificate-factory)
+[![Gem Version](http://img.shields.io/gem/v/certificate-factory.svg?style=flat-square)](https://rubygems.org/gems/certificate-factory)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://theodi.mit-license.org)
+
+# Certificate Factory
+
+Automagically generate [Open Data Certificates](https://certificates.theodi.org/)
+from a CKAN Dataset or Data.gov.uk atom feed.
+
+# Getting started
+
+## Clone the repo
+
+    git clone git@github.com:theodi/certificate-generator.git
+
+## Add some environment variables
+
+* Create a file named `.env`
+* Add the following you your newly-created file:
+
+    BASE_URI='https://certificates.theodi.org/'
+    ODC_USERNAME='{YOUR OPEN DATA CERTIFICATE USERNAME}'
+    ODC_API_KEY='{YOUR OPEN DATA CERTIFICATE API KEY}'
+
+You can get your API key from your Account page when logged into the Open Data Certificates website
+
+If you are running your own instance of Open Data Certificates (such as on your own machine), simply replace the `BASE_URL` with the URL of the instance you want to generate certificates on.
+
+## Run some commands!
+
+To generate a single certificate from a CKAN dataset, run the following:
+
+    rake generate:certificate URL="{CKAN dataset URL}"
+
+To generate multiple certificates as part of a campaign run the following:
+
+    rake generate:certificates CAMPAIGN=name URL="http://data.gov.uk/feeds/custom.atom"
+
+This will iterate through the feed and queue up all datasets in the feed by default, if you want to limit it specify a `LIMIT` parameter like so:
+
+    rake generate:certificates CAMPAIGN=name URL="http://data.gov.uk/feeds/custom.atom" LIMIT=2
+
+By default it will store the links to result urls in `CAMPAIGN.csv` you can change this by specifying an `OUTPUT` parameter in case you want a descriptive campaign name but a simpler result outputfile:
+
+    rake generate:certificates OUTPUT=output.csv CAMPAIGN=name URL="http://data.gov.uk/feeds/custom.atom" LIMIT=2
+
+If you want to collect the results of the campaign run in a csv file then you can run:
+
+    rake generate:results FILE=output.csv RESULTS=results.csv
+
+Specifying the output of the `generate` task as `FILE`. This will collect the results of the import, waiting for each job to finish.

data/Rakefile

@@ -0,0 +1,114 @@
+$:.unshift File.join( File.dirname(__FILE__), "lib")
+
+require 'rspec/core/rake_task'
+require 'logger'
+require 'csv'
+require 'httparty'
+require 'certificate-factory'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+logger.formatter = proc {|level, datetime, _, msg| msg + "\n"}
+
+namespace :generate do
+
+  task :certificate do
+    if ENV['URL']
+      cert = CertificateFactory::Certificate.new(ENV['URL'])
+      gen = cert.generate
+      if gen[:success] == "pending"
+        logger.info "pending: #{gen[:dataset_url]}"
+        result = cert.result
+
+        logger.info "published: #{result[:published]}"
+        if result[:success]
+          logger.info "user: #{result[:user]}"
+          logger.info "certificate_url: #{result[:certificate_url]}"
+        end
+      else
+        logger.error "#{gen[:error]} #{gen[:documentation_url]}"
+        puts gen.inspect
+      end
+    else
+      logger.error "Please specify a URL to generate a certificate for"
+    end
+  end
+
+  task :certificates do
+    url = ENV['URL']
+    file = ENV['FILE']
+    if (url || file) && (campaign = ENV['CAMPAIGN'])
+      #dated_campaign = [campaign, DateTime.now.iso8601].join('-')
+      # Create factory
+      output = ENV.fetch("OUTPUT", "#{campaign}.csv")
+      limit = ENV['LIMIT'].to_i if ENV['LIMIT']
+      if url
+        factory = CertificateFactory::Factory.new(feed: url, limit: limit, campaign: campaign, logger: logger)
+      elsif file
+        factory = CertificateFactory::CSVFactory.new(file: file, limit: limit, campaign: campaign, logger: logger)
+      end
+      count = 0
+      CSV.open(output, "w") do |csv|
+        csv << ["documentation_url", "dataset_url"]
+        factory.build do |r|
+          csv << r.values_at(:documentation_url, :dataset_url)
+          logger.info "#{r[:success]}: #{r[:documentation_url]}"
+          count += 1
+        end
+      end
+      logger.info "#{count} certificates queued. See #{output} for results"
+    else
+      logger.error "Please specify a URL for a feed and a CAMPAIGN to generate certificates for"
+    end
+  end
+
+  task :results do
+    if path = ENV['FILE']
+      if output = ENV['RESULTS']
+        CSV.open(output, 'w') do |csv|
+          csv << ["Success?", "Published?", "Documenation URL", "Certificate URL", "User"]
+          CSV.foreach(path, :headers => :first_row) do |c|
+            if dataset_url = c["dataset_url"]
+              puts dataset_url
+              result = CertificateFactory::Certificate.new(c['documentation_url'], :dataset_url => dataset_url).result
+              csv << result.values_at(:success, :published, :documentation_url, :certificate_url, :user)
+            end
+          end
+        end
+      else
+        logger.error "Please specify a RESULTS path"
+      end
+    else
+      logger.error "Please specify a FILE to check for results from"
+    end
+  end
+
+end
+
+namespace :update do
+  task :certificate do
+    if ENV['URL']
+      cert = CertificateFactory::Certificate.new(ENV['URL'])
+      gen = cert.update
+      if gen[:success] == "pending" || gen[:success] == true
+        puts gen.inspect
+        result = cert.result
+
+        if result[:published]
+          logger.info "published"
+        end
+        logger.info "user: #{result[:user]}"
+        logger.info "certificate_url: #{result[:certificate_url]}"
+      else
+        logger.error "#{gen[:error]} #{gen[:documentation_url]}"
+        puts gen.inspect
+      end
+    else
+      logger.error "Please specify a URL to generate a certificate for"
+    end
+  end
+end

data/certificate-factory.gemspec

@@ -0,0 +1,33 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "certificate-factory/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "certificate-factory"
+  s.version     = CertificateFactory::VERSION
+  s.authors     = ["Stuart Harrison"]
+  s.email       = ["tech@theodi.org"]
+  s.homepage    = "http://theodi.org"
+  s.summary     = "Automagically generate Open Data Certificates from a CKAN Dataset or Data.gov.uk atom feed."
+  s.description = "Automagically generate Open Data Certificates from a CKAN Dataset or Data.gov.uk atom feed."
+  s.license     = "MIT"
+
+  s.files = `git ls-files`.split($\)
+  s.require_paths = ["lib", "app"]
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "httparty"
+  s.add_dependency "dotenv"
+  s.add_dependency "rake"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov-rcov"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "pry-remote"
+end

data/env.example

@@ -0,0 +1,3 @@
+BASE_URI='http://open-data-certificate.dev'
+ODC_USERNAME=''
+ODC_API_KEY=''

data/lib/certificate-factory.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'httparty'
+require 'dotenv'
+
+Dotenv.load
+
+require 'certificate-factory/api'
+require 'certificate-factory/certificate'
+require 'certificate-factory/factory'
+
+module CertificateFactory
+
+end