release_dove 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41fd840eac471b8770900d540bc81a7744e0c5d9
+  data.tar.gz: 09b2a6004a6ccc128b0281350caacf9ae2d23ef8
+SHA512:
+  metadata.gz: 2aec706627d3d74a08ecbde54a801b58463968af93110422239c6556ba99a68f4a25079a1b3983f5c340e1ed5f769f0ab45fd4a6d691cd7cd69a2fcb3ed297ba
+  data.tar.gz: 88e21dc6963bff16be77d8ba3bc5db719d9063a59e67078654cd9ea6e6b3bc2625e78b70dc02982d7be835a79d8f6d7d60274188f5ad95dd2b1023ddd5b930fb

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/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'test/test_helper.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb'
+    - 'node_modules/**/*'
+
+AlignParameters:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Style/BlockComments:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Release Dove Change log
+
+## [0.1.0] - 2016-10-14
+### Added
+- Basic API which returns a collection of releases in JSON format
+- Cover with basic funcitonal tests

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in release_dove.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oleg
+
+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,56 @@
+# Release Dove
+[![Build Status](https://travis-ci.org/gafrom/release_dove.svg)](https://travis-ci.org/gafrom/release_dove)
+
+Dead-simple widget allowing you to receive notifications about new releases of your application in a form of nice pop-up bar.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+```ruby
+gem 'release_dove'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install release_dove
+
+Then drop a line to `routes.rb` to specify where you want your colleciton of releases:
+```ruby
+mount ReleaseDove::Application => '/releases'
+```
+
+Finally, include the front-end part:
+```javascript
+TODO: include npm package 'release_dove'
+```
+
+## Usage
+
+When running without from-end part, _https://you_app.com/releases_ will return a collection of releases in `JSON` format from your `CHANGELOG.md` file, providing the latter is maintained in a [conventional way](http://keepachangelog.com/en/0.3.0/).
+
+## Release attributes
+
+Releases have the following attributes:
+
+| Attribute   | Description                             | Example                                                   |
+|-----------  |---------------------------------------- |---------------------------------------------------------  |
+| `id`        | number, starting from earliest release  | 5                                                         |
+| `version`   | version of release, if specified        | 1.2.3                                                     |
+| `date`      | release date                            | 2016-10-15                                                |
+| `header`    | content of release header tag           | [1.2.3] - 2016-10-15                                      |
+| `content`   | full content of release                 | ## [1.2.3] - 2016-10-15 ### Added - Basic functionality   |
+
+TODO: Write usage instructions here with npm package included
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gafrom/release_dove.
+
+## 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,7 @@
+# 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 'release_dove'
+
+# 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,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/lib/release_dove/release.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+require 'English'
+class ReleaseDove::Release
+  attr_reader :id, :date, :version, :header, :content
+
+  CHANGELOG = './CHANGELOG.md'
+  TAG = /^.*(?<header>\[Unreleased\]|\[(?<version>\d+\.\d+\.\d+)\].*(?<date>\d{4}\-\d{2}\-\d{2}))$/i
+
+  class << self
+    def all
+      return @all if @all
+
+      @all = []
+      releases.each { |*args| @all << new(*args) }
+
+      @all
+    end
+
+    def take
+      all.first
+    end
+
+    alias last take
+
+    def first
+      all.last
+    end
+
+    def size
+      all.size
+    end
+    alias count size
+    alias length size
+
+    def find(id)
+      id = id.to_i
+      releases = all
+      length = releases.length
+      return unless (1..length).cover? id
+
+      i = length - id
+      releases.fetch(i)
+    end
+
+    private
+
+    def releases
+      return to_enum(:releases) unless block_given?
+
+      log_content, log_indices = read_from_file
+
+      log_indices.each_with_index do |position, i|
+        next_position = log_indices[i + 1]
+        length = next_position ? next_position - position : log_content.length - position
+        id = log_indices.size - i
+        content = log_content[position, length]
+
+        yield id, content
+      end
+    end
+
+    def read_from_file
+      file = File.open(CHANGELOG, 'rb', encoding: 'utf-8')
+      content = file.read
+      indices = content.enum_for(:scan, TAG).map { Regexp.last_match.begin(0) }
+      file.close
+
+      [content, indices]
+    end
+  end
+
+  def initialize(id, content)
+    @id = id
+    @content = content
+
+    return unless TAG =~ content
+
+    @version = $LAST_MATCH_INFO[:version]
+    @header = $LAST_MATCH_INFO[:header]
+    @date = begin
+              Date.parse $LAST_MATCH_INFO[:date].to_s
+            rescue ArgumentError
+              nil
+            end
+  end
+
+  def ==(other)
+    id == other.id
+  end
+end

data/lib/release_dove/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module ReleaseDove
+  VERSION = '0.1.0'
+end

data/lib/release_dove.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'release_dove/version'
+require 'release_dove/release'
+
+module ReleaseDove
+  class Application
+    def self.call(*)
+      ['200', { 'Content-Type' => 'application/json; charset=utf-8' }, [Release.all.to_json]]
+    end
+  end
+end

data/release_dove.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'release_dove/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'release_dove'
+  spec.version       = ReleaseDove::VERSION
+  spec.authors       = ['Oleg']
+  spec.email         = ['gafrom@gmail.com']
+
+  spec.summary       = 'Simple widget to notify about new releases of your applicaiton.'
+  spec.description   = "This is a backend part of easy-to-embed widget with pop-up \
+                        notifications about your application's new releases."
+  spec.homepage      = 'https://github.com/gafrom/release_dove'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'https://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.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'json', '~> 2.0.2'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: release_dove
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: This is a backend part of easy-to-embed widget with pop-up                         notifications
+  about your application's new releases.
+email:
+- gafrom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/release_dove.rb
+- lib/release_dove/release.rb
+- lib/release_dove/version.rb
+- release_dove.gemspec
+homepage: https://github.com/gafrom/release_dove
+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.1
+signing_key: 
+specification_version: 4
+summary: Simple widget to notify about new releases of your applicaiton.
+test_files: []