jira_cache 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 150824534aedbe261c0c3b126f7055e1f2072065
+  data.tar.gz: e96cbfcf5b638b4666b6a5e12524324f3dc9891e
+SHA512:
+  metadata.gz: e13ead3a828a3353abad58a2253494e61235ab5a8a98d1b5ae5aa131236079f6054902ecd62b68e3705eca4e62b7d70f5f80a62153926ca6a45cca43e8777af4
+  data.tar.gz: 97da7cfc2f762fc650e51662b9391619cdfdbb5138c6f9e1173e1072de20c4ec969e025ffaf88ac03cfddbac4a4eaa3a6764ce71552be55a8d0be08f18dc30e8

data/.codeclimate.yml

@@ -0,0 +1,10 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - config/**
+    - lib/**
+    - "**.rb"
+exclude_paths:
+  - spec/**/*

data/.env.example

@@ -0,0 +1,10 @@
+APP_ENV=development
+DATABASE_URL=postgres://jira_cache_user:password@localhost:5432/jira_cache_development
+POSTGRES_USER=jira_cache_user
+POSTGRES_PASSWORD=password
+POSTGRES_DB=jira_cache_development
+JIRA_DOMAIN=project.atlassian.net
+JIRA_USERNAME=user.name
+JIRA_PASSWORD=PASSW0RD
+JIRA_PROJECT_KEY=PJ
+JIRA_LOG_LEVEL=INFO

data/.env.test

@@ -0,0 +1,10 @@
+APP_ENV=test
+DATABASE_URL=postgres://jira_cache_user:password@localhost:5433/jira_cache_test
+POSTGRES_USER=jira_cache_user
+POSTGRES_PASSWORD=password
+POSTGRES_DB=jira_cache_test
+JIRA_DOMAIN=test.atlassian.net
+JIRA_USERNAME=username
+JIRA_PASSWORD=password
+JIRA_PROJECT_KEY=PJ
+JIRA_LOG_LEVEL=DEBUG

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.env.development
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/LineLength:
+  Max: 120
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/EmptyLinesAroundBody:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation

data/.ruby-gemset

@@ -0,0 +1 @@
+jira_cache

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler
+before_script:
+  - psql -c 'create database travis_ci_test;' -U postgres
+after_success: bundle exec codeclimate-test-reporter
+services:
+  - postgresql
+addons:
+  postgresql: "9.4"
+env:
+  global:
+    - APP_ENV=test
+    - DATABASE_URL=postgres://localhost:5432/travis_ci_test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+#
+# Specify your gem"s dependencies in jira_cache.gemspec
+gemspec
+
+group :development do
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-shotgun", require: false
+  gem "terminal-notifier-guard"
+end
+
+group :test do
+  gem "rspec"
+  gem "rack-test"
+  gem "webmock"
+  gem "coveralls", require: false
+  gem "simplecov", require: false
+  gem "simplecov-json", require: false
+  gem "timecop"
+end

data/Guardfile

@@ -0,0 +1 @@
+config/Guardfile

data/HISTORY.md

@@ -0,0 +1,22 @@
+# History
+
+## 2017-02-19 - 0.2.0
+
+- Supporting fetching of all issues without filtering on a specific project key.
+- Simplified interface by relying to default values for notifier, client...
+  using environment variables to configure them.
+
+Interface changes:
+
+- `JiraCache.sync_project_issues(client, project_key)` becomes
+  `JiraCache.sync_issues(client: client, project_key: project_key)`.
+- `JiraCache.sync_issue(client, issue_key)` becomes
+  `JiraCache.sync_issue(issue_key, client: client)`.
+- `JiraCache::Sync.sync_project_issues(project_key)` becomes 
+  `JiraCache::Sync.sync_issues(project_key: project_key)`.
+- `JiraCache.sync_issue(client, 'issue_key')` becomes
+  `JiraCache.sync_issue('issue_key', client: client)`.
+- The webhook app may now be run using `run JiraCache.webhook_app`
+  instead of `...webhook_app(client)` if the default client may be
+  used (configured using environment variables).
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Romain Champourlier
+
+MIT License
+
+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,73 @@
+# JiraCache
+
+JiraCache enables storing JIRA issues fetched from the API in a local storage for easier and faster processing. This allows you to build applications performing complex operations on a large number of JIRA content without the JIRA's API latency.
+
+[![Build Status](https://travis-ci.org/rchampourlier/jira_cache.svg?branch=master)](https://travis-ci.org/rchampourlier/jira_cache)
+[![Code Climate](https://codeclimate.com/github/rchampourlier/jira_cache/badges/gpa.svg)](https://codeclimate.com/github/rchampourlier/jira_cache)
+[![Coverage Status](https://coveralls.io/repos/github/rchampourlier/jira_cache/badge.svg?branch=master)](https://coveralls.io/github/rchampourlier/jira_cache?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jira_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jira_cache
+
+## Usage
+
+Inside of `bin/console`:
+
+```ruby
+# Basic usage (relies on environment variables to configure the client,
+# see .env.example for details)
+JiraCache.sync_issue('ISSUE_KEY')
+
+# Using customized client and logger
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+client = JiraCache::Client.new(
+  domain: 'example.atlassian.net',
+  username: 'username',
+  password: 'password',
+  logger: logger
+)
+JiraCache.sync_issue('ISSUE_KEY', client: client)
+```
+
+## Advanced use
+
+### Getting notified on sync events
+
+When you trigger a project sync with `JiraCache.sync_project_issues(<project_key>)`,
+you can get notifications on every issue fetched by providing a notifier
+instance to `JiraCache::Client`:
+
+```
+JiraCache::Client.set_notifier(MyNotifier.new)
+```
+
+Your notifier class must implement the `#publish(event_name, data)` method. See `JiraCache::Notifier` class for more details.
+
+Your notifier's `#publish` method will get called synchronously on every issue fetch. Your responsible of making it being processed in the background if you don't want to slow down the fetching process. Also, beware that fetchs can be performed in multiple threads concurrently (by default 5, you can override it by setting `JiraCache::THREAD_POOL_SIZE`).
+
+Currently notified events are:
+- `fetched_issue`
+
+## Contributing
+
+1. Fork it ( https://github.com/rchampourlier/jira_cache/fork )
+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 a new Pull Request
+
+Check the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Load dependencies
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift File.expand_path('../..', __FILE__)
+require 'config/boot'
+
+require 'pry'
+Pry.start

data/bin/db/migrate

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if [ "$RACK_ENV" == "production" ]
+then
+  sequel -m config/db_migrations $DATABASE_URL
+else
+  export $(cat .env.development | xargs) && sequel -m config/db_migrations $DATABASE_URL
+fi

data/bin/db/psql

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if [ "$RACK_ENV" == "production" ]
+then
+  psql $DATABASE_URL
+else
+  export $(cat .env.development | xargs) && psql $DATABASE_URL
+fi

data/bin/db/reset

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if [ "$RACK_ENV" == "production" ]
+then
+  sequel -m config/db_migrations -M 0 $DATABASE_URL
+else
+  export $(cat .env.development | xargs) && sequel -m config/db_migrations -M 0 $DATABASE_URL
+fi

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/bin/sync

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Load dependencies
+require "rubygems"
+require "bundler/setup"
+require "logger"
+
+$LOAD_PATH.unshift File.expand_path("../..", __FILE__)
+require "config/boot"
+
+require "jira_cache/client"
+require "jira_cache/notifier"
+
+JiraCache.sync_issues(project_key: ENV["JIRA_PROJECT_KEY"])

data/config.ru

@@ -0,0 +1,7 @@
+ENV["RACK_ENV"] ||= ENV["APP_ENV"] ||= "development"
+
+root_dir = File.dirname(__FILE__)
+require File.join(root_dir, "config", "boot")
+require File.join(root_dir, "lib", "jira_cache", "webhook_app")
+
+run JiraCache.webhook_app

data/config/Guardfile

@@ -0,0 +1,35 @@
+# More info at https://github.com/guard/guard#readme
+
+directories %w(lib config spec)
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+group :test do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+end
+
+group :server do
+  guard :shotgun do
+    watch(/.+/) # watch *every* file in the directory
+  end
+end

data/config/boot.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+env = ENV["APP_ENV"] || "development"
+if env == "development" || env == "test"
+  require "dotenv"
+  Dotenv.load(".env.#{env}")
+end
+
+root_dir = File.expand_path("../..", __FILE__)
+$LOAD_PATH.unshift root_dir
+$LOAD_PATH.unshift File.join(root_dir, "lib")
+require "jira_cache"

data/config/db_migrations/001_create_issues.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Sequel.migration do
+  up do
+    create_table :jira_cache_issues do
+      String :key
+      column :data, "json"
+      DateTime :synced_at
+      DateTime :deleted_from_jira_at
+
+      # Timestamps
+      DateTime :created_at
+      DateTime :updated_at
+    end
+  end
+
+  down do
+    drop_table(:jira_cache_issues)
+  end
+end

data/docker-compose.yml

@@ -0,0 +1,25 @@
+version: '2'
+
+services:
+  pg-dev:
+    env_file:
+      - .env.development
+    image: postgres:9.4
+    ports:
+      - "5432:5432"
+    volumes:
+      - pg-dev-data:/var/lib/postgresql/data
+  pg-test:
+    env_file:
+      - .env.test
+    image: postgres:9.4
+    ports:
+      - "5433:5432"
+    volumes:
+      - pg-test-data:/var/lib/postgresql/data
+
+volumes:
+  pg-dev-data:
+    driver: local
+  pg-test-data:
+    driver: local