headsail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05f03189ed820907c20e6ea06b9b68a2a785feb5
+  data.tar.gz: 02ac8b3a9f57c55983a30f680f3191d99443f598
+SHA512:
+  metadata.gz: 4487c83e555555f13af185a2f2ecdba69036b9389351049c17d1e152825e460ecba355c77ea343ae609becf29d9ce32f78f3a5159f2df2e8241d785af487e77e
+  data.tar.gz: ba9e96a0156ab7100384b10bb3f4db2f5dc6c4301997c9a7e39f551795a1e660f296cbe45d19f389565d84b6580657c405c5bcfe763c7a70ed90389f0c7faceb

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at nsweeting@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicholas Sweeting
+
+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,41 @@
+# Headsail
+
+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/headsail`. 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 'headsail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install headsail
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/headsail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'headsail'
+require 'headsail/cli'
+
+cli = Headsail::CLI.new(ARGV)
+cli.run

data/bin/setup

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

data/headsail.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'headsail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "headsail"
+  spec.version       = Headsail::VERSION
+  spec.authors       = ["Nicholas Sweeting"]
+  spec.email         = ["nsweeting@gmail.com"]
+  spec.summary       = "Automated API data retrieval and storage."
+  spec.description   = "Automated API data retrieval and storage."
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "lib"
+  spec.executables   = ['headsail']
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "redis"
+  spec.add_development_dependency "concurrent-ruby"
+  spec.add_development_dependency "oauth"
+end

data/lib/headsail/api.rb

@@ -0,0 +1,22 @@
+module Headsail
+  class API
+    attr_reader :name, :timer, :method, :uri, :oauth
+
+    def initialize(config)
+      @name = config['name']
+      @timer = config['timer']
+      @oauth = config['oauth']
+      @method = config['request']['method']
+      @uri = build_uri(config['request'])
+    end
+
+    private
+
+    def build_uri(request)
+      return false if request.nil?
+      uri_full = URI(request['uri'])
+      uri_full.query = URI.encode_www_form(request['params']) if request['params']
+      uri_full
+    end
+  end
+end

data/lib/headsail/cli.rb

@@ -0,0 +1,64 @@
+require 'optparse'
+require 'headsail/configure'
+require 'headsail/launcher'
+
+module Headsail
+  # Handles the start of Headsail via command line
+  #
+  class CLI
+    attr_reader :launcher
+
+    # Creates a new CLI object, parsing the arguments that are passed to it,
+    # and readying a Launcher to be run
+    #
+    # @param argv [Array] an array of command-line arguments
+    def initialize(argv)
+      @argv = argv
+      @configure = nil
+      @parser = nil
+
+      setup_options
+      parse_options
+      @launcher = Launcher.new(@configure)
+    end
+
+    def run
+      @launcher.run
+    end
+
+    private
+
+    # Builds a Configure object based on options passed through the
+    # command line arguments.
+    #
+    def setup_options
+      @configure = Headsail::Configure.new.tap do |c|
+        @parser = OptionParser.new do |o|
+
+          o.banner = 'Usage: bundle exec bin/headsail [options]'
+
+          o.on('-a', '--apis PATH', 'Load PATH for api yaml file') do |arg|
+            c.load_apis(arg)
+          end
+
+          o.on('-s', '--start', 'Start the Headsail client') do
+            c.start_client = true
+          end
+
+          o.on('-h', '--help', 'Prints this help') do
+            puts o
+            exit
+          end
+
+        end
+      end
+    end
+
+    def parse_options
+      @parser.parse!(@argv)
+    rescue
+      print 'Unsupported Options'
+      exit 1
+    end
+  end
+end

data/lib/headsail/client.rb

@@ -0,0 +1,26 @@
+require 'headsail/task'
+
+module Headsail
+  # The main event loop for retrieving data from APIS
+  #
+  class Client
+    def initialize(configure)
+      @configure = configure
+      @threads = []
+      @tasks = []
+      setup_tasks
+    end
+
+    def run
+      @tasks.each { |task| @threads << task.run }
+      @threads.map(&:execute)
+      loop { sleep 300 }
+    end
+
+    private
+
+    def setup_tasks
+      @configure.apis.each { |api| @tasks << Task.new(api) }
+    end
+  end
+end

data/lib/headsail/configure.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+
+module Headsail
+  class Configure
+    attr_accessor :start_client
+    attr_reader :apis
+
+    def load_apis(path)
+      @apis = YAML.load_file(path)
+    end
+  end
+end

data/lib/headsail/event.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+module Headsail
+  class Event
+    def initialize(event_name)
+      @event_name = event_name
+      @logger = Logger.new(STDOUT)
+    end
+
+    def request(http, method)
+      message = "#{@event_name} / #{method} REQUEST / #{http.code} - #{http.code_status.to_s}"
+      @logger.info(message)
+    end
+  end
+end

data/lib/headsail/http.rb

@@ -0,0 +1,62 @@
+require 'headsail/oauth'
+
+module Headsail
+  class HTTP
+    attr_reader :response
+
+    def initialize(api)
+      @api = api
+      @response = nil
+      @oauth = determine_oauth
+      @request = determine_request
+    end
+
+    def run
+      send(@request)
+    end
+
+    def body
+      @response.body
+    end
+
+    def code
+      @response.code
+    end
+
+    def code_status
+      case @response.code.to_i
+      when 200 || 201
+        :SUCCESS
+      when (400..499)
+        :BAD_REQUEST
+      when (500..599)
+        :SERVER_PROBLEMS
+      end
+    end
+
+    private
+
+    def get_request_no_oauth
+      @response = Net::HTTP.get_response(@api.uri)
+      code_status == :SUCCESS
+    end
+
+    def get_request_with_oauth
+      @response = @oauth.access_token.get(@api.uri.to_s)
+      code_status == :SUCCESS
+    end
+
+    def determine_request
+      case
+      when @api.method == 'GET' && @oauth
+        :get_request_with_oauth
+      when @api.method == 'GET' && @oauth == false
+        :get_request_no_oauth
+      end
+    end
+
+    def determine_oauth
+      @api.oauth ? OAuth.new(@api.oauth) : false
+    end
+  end
+end

data/lib/headsail/launcher.rb

@@ -0,0 +1,29 @@
+require 'headsail/client'
+
+module Headsail
+  # Determines the action to be taken based on the Configure object
+  #
+  class Launcher
+    attr_reader :client
+
+    def initialize(configure)
+      @configure = configure
+    end
+
+    def run
+      case
+      when @configure.start_client
+        start_client
+      end
+    end
+
+    private
+
+    # Creates a new Client object - the main process used for data collection
+    #
+    def start_client
+      @client = Client.new(@configure)
+      @client.run
+    end
+  end
+end

data/lib/headsail/oauth.rb

@@ -0,0 +1,23 @@
+require 'oauth'
+
+module Headsail
+  class OAuth
+    attr_reader :access_token
+
+    def initialize(oauth)
+      return false if oauth.nil?
+      @oauth = oauth
+      @access_token = oauth_token
+    end
+
+    private
+
+    def oauth_token
+      ::OAuth::AccessToken.new(consumer, @oauth['access_token'], @oauth['access_token_secret'])
+    end
+
+    def consumer
+      ::OAuth::Consumer.new(@oauth['consumer_key'], @oauth['consumer_secret'], site: @oauth['site'])
+    end
+  end
+end

data/lib/headsail/redis.rb

@@ -0,0 +1,47 @@
+require 'redis'
+
+module Headsail
+  class Redis
+    attr_reader :connection
+
+    def initialize(key_name)
+      @key_name = key_name
+      setup_connection
+      setup_service
+      setup_next_id
+    end
+
+    def add(data)
+      @connection.incr(next_id_key)
+      @connection.set(new_key, data)
+    end
+
+    private
+
+    def new_key
+      "#{@key_name}:#{next_id}"
+    end
+
+    def next_id
+      @connection.get(next_id_key)
+    end
+
+    def next_id_key
+      @next_id_key ||= "#{@key_name}:next_id"
+    end
+
+    def setup_connection
+      @connection = ::Redis.new(url: ENV['REDIS_URL'])
+    end
+
+    def setup_service
+      return if @connection.exists(@key_name)
+      @connection.set(@key_name, true)
+      @connection.lpush('apis', @key_name)
+    end
+
+    def setup_next_id
+      @connection.set(next_id_key, 0) unless @connection.exists(next_id_key)
+    end
+  end
+end

data/lib/headsail/task.rb

@@ -0,0 +1,23 @@
+require 'concurrent'
+require 'headsail/api'
+require 'headsail/event'
+require 'headsail/http'
+require 'headsail/redis'
+
+module Headsail
+  class Task
+    def initialize(config)
+      @api = API.new(config)
+      @redis = Redis.new(@api.name)
+      @http = HTTP.new(@api)
+      @event = Event.new(@api.name)
+    end
+
+    def run
+      Concurrent::TimerTask.new(execution_interval: @api.timer) do
+        @redis.add(@http.body) if @http.run
+        @event.request(@http, @api.method)
+      end
+    end
+  end
+end

data/lib/headsail/version.rb

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

data/lib/headsail.rb

@@ -0,0 +1,2 @@
+require 'headsail/version'
+require 'byebug'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: headsail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Sweeting
+autorequire: 
+bindir: lib
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: redis
+  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: concurrent-ruby
+  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: oauth
+  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: Automated API data retrieval and storage.
+email:
+- nsweeting@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/headsail
+- bin/setup
+- headsail.gemspec
+- lib/headsail.rb
+- lib/headsail/api.rb
+- lib/headsail/cli.rb
+- lib/headsail/client.rb
+- lib/headsail/configure.rb
+- lib/headsail/event.rb
+- lib/headsail/http.rb
+- lib/headsail/launcher.rb
+- lib/headsail/oauth.rb
+- lib/headsail/redis.rb
+- lib/headsail/task.rb
+- lib/headsail/version.rb
+homepage: 
+licenses:
+- MIT
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Automated API data retrieval and storage.
+test_files: []