github_events_export 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a8e220fc05a7b340169af0f9857d8f8326b4e9a14a77252997e5c14c94b9914
+  data.tar.gz: 1a264a0be1d8f5a19da87a7b9f3a9a91673e71b8c4f7452f0a1b5c3d7ed85b1e
+SHA512:
+  metadata.gz: 3c749dd31f988405b75fa48dd24eeed93e874d8b57433792d5827f0bbafa4c92ae882741345597437788722951d5ad52d9ebce019b1b05b42ec860c16da30381
+  data.tar.gz: c8ff9cbce13bf93ec4ee96c097273203a17f79410013bee8af1ff187e4c1d31287bb457980bffefc9ee4d63886ef146c5de8d40a8737d3aaf17d59879737bd63

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    github_events_export (0.1.0)
+      octokit (~> 4.15.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.3)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    octokit (4.15.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (4.0.2)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  github_events_export!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,36 @@
+# GithubEventsExport
+
+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/github_events_export`. 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 'github_events_export'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install github_events_export
+
+## 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/garethrees/github_events_export.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'github_events_export'
+
+# 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(__FILE__)

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/exe/github-events-export

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'github_events_export'
+exit GithubEventsExport::CLI.run(ARGV)

data/github_events_export.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_events_export/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github_events_export'
+  spec.version       = GithubEventsExport::VERSION
+  spec.authors       = ['Gareth Rees']
+  spec.email         = ['gareth@garethrees.co.uk']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Export GitHub events to JSON files'
+  spec.homepage      = 'https://github.com/garethrees/github_events_export'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(spec)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'octokit', '~> 4.15.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/github_events_export.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'octokit'
+
+require 'github_events_export/cli'
+require 'github_events_export/event'
+require 'github_events_export/export'
+require 'github_events_export/options'
+require 'github_events_export/version'
+
+# Export GitHub Events to individual JSON files
+module GithubEventsExport
+end

data/lib/github_events_export/cli.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubEventsExport
+  # Entrypoint for CLI usage
+  class CLI
+    STATUS_SUCCESS = 0
+    STATUS_FAILURE = 1
+
+    def self.run(argv)
+      new(Options.new(argv)).run
+    end
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      Export.new(client).run
+      STATUS_SUCCESS
+    end
+
+    private
+
+    attr_reader :options
+
+    def client
+      @client ||= ::Octokit::Client.new(
+        access_token: options[:token],
+        auto_paginate: true
+      )
+    end
+  end
+end

data/lib/github_events_export/event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module GithubEventsExport
+  # Wrapper around a GitHub Event
+  # https://developer.github.com/v3/activity/events
+  class Event
+    def self.all(client)
+      client.user_events(client.user.id).map { |e| new(e) }
+    end
+
+    def initialize(event_data)
+      @event_data = event_data
+    end
+
+    def save
+      save! if changed?
+    end
+
+    def save!
+      File.write(filename, to_json)
+    end
+
+    private
+
+    attr_reader :event_data
+
+    def changed?
+      return true unless persisted?
+
+      Digest::MD5.hexdigest(to_json) !=
+        Digest::MD5.hexdigest(File.read(filename))
+    end
+
+    def persisted?
+      File.exist?(filename)
+    end
+
+    def filename
+      "#{event_data.id}.json"
+    end
+
+    def to_json
+      event_data.to_h.to_json
+    end
+  end
+end

data/lib/github_events_export/export.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GithubEventsExport
+  # Save each Event to disk
+  class Export
+    def initialize(client)
+      @client = client
+    end
+
+    def run
+      Event.all(client).each(&:save)
+    end
+
+    private
+
+    attr_reader :client
+  end
+end

data/lib/github_events_export/options.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module GithubEventsExport
+  # Parse CLI options
+  class Options
+    def initialize(args)
+      @args = args
+    end
+
+    def [](key)
+      parse[key]
+    end
+
+    def to_hash
+      parse
+    end
+
+    private
+
+    attr_reader :args
+
+    def parse
+      options = {}
+      option_parser.parse!(args, into: options)
+      options
+    end
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: github-events-export [options]'
+        opts.on('--token=TOKEN', 'GitHub Access Token')
+        opts.on('-v', '--version', 'Print version')
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/github_events_export/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GithubEventsExport
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: github_events_export
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gareth Rees
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.15.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- gareth@garethrees.co.uk
+executables:
+- github-events-export
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github-events-export
+- github_events_export.gemspec
+- lib/github_events_export.rb
+- lib/github_events_export/cli.rb
+- lib/github_events_export/event.rb
+- lib/github_events_export/export.rb
+- lib/github_events_export/options.rb
+- lib/github_events_export/version.rb
+homepage: https://github.com/garethrees/github_events_export
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/garethrees/github_events_export
+  source_code_uri: https://github.com/garethrees/github_events_export
+  changelog_uri: https://github.com/garethrees/github_events_export/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Export GitHub events to JSON files
+test_files: []