auctioneer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e893eb7d7ad2d71547b2e288b0bf161cb409a43
+  data.tar.gz: c2a97e50333ef5ef3d572a9258219fe7fd6e47f9
+SHA512:
+  metadata.gz: 40c291467691f769286bd54c31724f4429b42665f769a5e2b99a5a374e16aaef7cfe49f9c7cd5c6ffd0e2e923c84ef1f69cbc5cf776e0514bdca8fae10dc07a8
+  data.tar.gz: 6c4fcab4cee5ffa90668f89335cc81eae70fefa649c7aa4b1282da168b04cc115fbb00272aed4d9fb0f5995604cf19664705f32895a02bbaf79332903ebe5e6f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.4

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## Welcome!
+
+We're so glad you're thinking about contributing to an 18F open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
+
+We want to ensure a welcoming environment for all of our projects. Our staff follow the [18F Code of Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md) and all contributors should do the same.
+
+We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md).
+
+If you have any questions or want to read more, check out the [18F Open Source Policy GitHub repository]( https://github.com/18f/open-source-policy), or just [shoot us an email](mailto:18f@gsa.gov).
+
+## Public domain
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,31 @@
+As a work of the United States Government, this project is in the
+public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+## CC0 1.0 Universal Summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+### No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.

data/README.md

@@ -0,0 +1,64 @@
+# Auctioneer
+
+A Ruby API Client for 18F's Micropurchase application.
+
+## Requirements
+
+- Ruby
+
+## Installation
+
+This is not yet a gem. Many parts are still moving, use at your own risk, etc, etc.
+
+Clone the repo, `cd` into it, run `bundle`.
+
+## Obtaining an API key
+
+Go to https://github.com/settings/tokens (make sure you are logged in), and generate a Personal Access Token. Uncheck all of the "scope" options, too.
+
+Add this key to your `.zshrc`, `.bash_profile` or similar as:
+
+```
+export MICROPURCHASE_API_KEY='your personal access token goes here'
+```
+
+## Use
+
+Run `ruby auctioneer.rb` to access the API client inside of a `pry` session.
+
+## Admin Methods
+
+These methods are only available to authenticated system admins (e.g. 18F staff only).
+
+### admin_users
+
+```ruby
+client.admin_user
+#=> {...}
+```
+
+### admin_auctions
+
+```ruby
+client.admin_auctions
+#=> {...}
+```
+
+### Reporting tasks
+
+We're including in this gem methods for common data reporting/updating tasks.
+
+#### CSV of Email addresses
+
+```ruby
+email_csv
+# generates a CSV of email addresses in `emails.csv` in the root of the project
+```
+
+## Public domain
+
+This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
+
+> This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+>
+> All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/auctioneer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auctioneer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auctioneer"
+  spec.version       = Auctioneer::VERSION
+  spec.authors       = ["Alan deLevie"]
+  spec.email         = ["alan.delevie@gsa.gov"]
+
+  spec.summary       = %q{Ruby access to 18F's micro-purchase API}
+  spec.homepage      = "https://micropurchase.18f.gov"
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/auctioneer.rb

@@ -0,0 +1,60 @@
+require 'bundler/setup'
+require 'pry'
+require 'curb'
+require 'json'
+
+module Auctioneer
+  class Client
+    def initialize(api_key: ENV['MICROPURCHASE_API_KEY'])
+      #@client  = HTTPClient.new
+      @headers = {'Accept' => 'text/x-json'}
+      @headers['Api-Key'] = api_key if api_key
+    end
+
+    def admin_users
+      get(Auctioneer::Protocol.admin_users_path)
+    end
+
+    def admin_auctions
+      get(Auctioneer::Protocol.admin_auctions_path)
+    end
+
+    def get(url)
+      #response = @client.get(path, nil, @headers)
+      http = Curl.get(url) do |http|
+        http.headers = @headers
+      end
+
+      JSON.parse(http.body_str)
+    end
+  end
+
+  module Protocol
+    BASE_URL = 'https://micropurchase.18f.gov'
+
+    def self.admin_auctions_path
+      "#{BASE_URL}/admin/auctions"
+    end
+
+    def self.admin_users_path
+      "#{BASE_URL}/admin/users"
+    end
+  end
+end
+
+def email_csv
+  client = Auctioneer::Client.new
+  users = client.admin_users['admin_report']['non_admin_users']
+  emails = users.map {|u| u['email']}.reject(&:nil?)
+
+  require "csv"
+  CSV.open("emails.csv", "wb") do |csv|
+    emails.each do |email|
+      csv << [email]
+    end
+  end
+end
+
+client = Auctioneer::Client.new
+
+binding.pry

data/auctioneer/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/auctioneer/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/auctioneer/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.4

data/auctioneer/Gemfile

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

data/auctioneer/README.md

@@ -0,0 +1,36 @@
+# Auctioneer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/auctioneer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auctioneer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auctioneer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/auctioneer.
+

data/auctioneer/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/auctioneer/auctioneer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auctioneer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auctioneer"
+  spec.version       = Auctioneer::VERSION
+  spec.authors       = ["Alan deLevie"]
+  spec.email         = ["alan.delevie@gsa.gov"]
+
+  spec.summary       = %q{Ruby access to 18F's micro-purchase API}
+  spec.description   = %q{A longer description about Ruby access to 18F's micro-purchase API}
+  spec.homepage      = "https://micropurchase.18f.gov"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/auctioneer/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "auctioneer"
+
+# 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
+
+require "irb"
+IRB.start

data/auctioneer/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/auctioneer/lib/auctioneer.rb

@@ -0,0 +1,5 @@
+require "auctioneer/version"
+
+module Auctioneer
+  # Your code goes here...
+end

data/auctioneer/lib/auctioneer/version.rb

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

data/auctioneer/spec/auctioneer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Auctioneer do
+  it 'has a version number' do
+    expect(Auctioneer::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/auctioneer/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'auctioneer'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "auctioneer"
+
+# 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
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/auctioneer.rb

@@ -0,0 +1,5 @@
+require "auctioneer/version"
+
+module Auctioneer
+  # Your code goes here...
+end

data/lib/auctioneer/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: auctioneer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  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: 
+email:
+- alan.delevie@gsa.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- auctioneer.gemspec
+- auctioneer.rb
+- auctioneer/.gitignore
+- auctioneer/.rspec
+- auctioneer/.travis.yml
+- auctioneer/Gemfile
+- auctioneer/README.md
+- auctioneer/Rakefile
+- auctioneer/auctioneer.gemspec
+- auctioneer/bin/console
+- auctioneer/bin/setup
+- auctioneer/lib/auctioneer.rb
+- auctioneer/lib/auctioneer/version.rb
+- auctioneer/spec/auctioneer_spec.rb
+- auctioneer/spec/spec_helper.rb
+- bin/console
+- bin/setup
+- lib/auctioneer.rb
+- lib/auctioneer/version.rb
+homepage: https://micropurchase.18f.gov
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Ruby access to 18F's micro-purchase API
+test_files: []