ruby-notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 368417a15f4d68bd03abc9733fc98d9bdf26a318
+  data.tar.gz: 9361fe2762b9412a514e0ada7a267376cef4b67d
+SHA512:
+  metadata.gz: '08057f59d09db8d813859b0f90b13811301d8184b085c108fe749cecf7335012fcbc3fcaf1d8e8685117400d33155c208c0c41511fe85b748e8358d8dd1ccffb'
+  data.tar.gz: 541ea926b1a380c0c0dc8d93ba6249e6a2227dcda92682eb200b48b5e9e986ca3f352c47cfda915647e193e1b6a7a460a63f5f5590aafd34cd168ee769b853ee

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.0.pre.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in notifications.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ruby-notifications (0.1.0)
+      ruby-dbus (~> 0.14.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby-dbus (0.14.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruby-notifications!
+
+BUNDLED WITH
+   1.16.0.pre.1

data/README.md

@@ -0,0 +1,58 @@
+# Notifications
+
+A simple interface for the org.freedesktop.Notifications DBus service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install notifications
+
+## Usage
+
+```ruby
+require 'notifications'
+# Create the service interface
+service = Notifications::NotificationService.new
+
+# Create a notification object
+# 'appname' is only required named parameter but isn't very
+# useful on its own.
+notification = Notifications::Notification.new(appname: "test",
+                                               summary: "test",
+                                               body: "A test notification")
+
+# Retrieve the service object's methods internally.
+# May refactor as raised initializer exception in the
+# future.
+service.try_introspect
+
+# Send the notification
+service.send_notification notification
+
+# Can also short-hand service.close_notification in this instance
+# as the service interface tracks the last sent notification for
+# improved usability.
+service.close_notification notification
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/CrunchwrapSupreme/ruby-notifications.

data/Rakefile

@@ -0,0 +1,6 @@
+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 "notifications"
+
+# 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/lib/notifications.rb

@@ -0,0 +1,189 @@
+#require "notifications/version"
+require "dbus"
+require "timeout"
+
+module Notifications
+  NOTIF_SERVICE = 'org.freedesktop.Notifications'
+  NOTIF_OBJECT = '/org/freedesktop/Notifications'
+  VALID_CAPABILITIES = [ 'action-icons', 'actions', 'body', 'body-hyperlinks', 'body-images',
+                         'body-markup', 'icon-multi', 'icon-static', 'persistence', 'sound' ]
+  VALID_CAPABILITIES.sort!
+  NOTIF_SERVICE.freeze
+  NOTIF_OBJECT.freeze
+  VALID_CAPABILITIES.freeze
+  TIMEOUT = 5
+
+  class NotificationDaemonError < RuntimeError
+    def initialize
+      super "Notification daemon not implemented or unavailable."
+    end
+  end
+
+  class CommandNotImplementedError < NoMethodError
+    def initialize(command="Command")
+      super "#{msg} not implemented by the #{Notifications.NOTIF_SERVICE} service."
+    end
+  end
+
+  class ObjectIntrospectionError < NoMethodError
+    def initialize
+      super "Object not introspected. Introspect before calling proxy methods."
+    end
+  end
+
+  class NotificationService
+    attr_reader :bus, :service
+
+    def service_object
+      @service_obj
+    end
+
+    def introspected?
+      @service_obj.introspected
+    end
+
+    def capabilities
+      @capabilities ||= try_to { @service_obj.GetCapabilities }
+      @capabilities
+    end
+
+    def initialize
+      @bus = DBus::SessionBus.instance
+      @service = @bus.service Notifications::NOTIF_SERVICE
+      @service_obj = @service.object Notifications::NOTIF_OBJECT
+
+
+      if not @service.exists? then
+        raise NotificationDaemonError.new
+      end
+
+
+      @service_obj.define_singleton_method(:method_missing) do |name, *args, &block|
+        if not self.introspected then
+          raise ObjectIntrospectionError
+        else
+          raise CommandNotImplementedError name.to_s
+        end
+      end
+
+      @supports = {}
+    end
+
+    def try_introspect
+      begin
+        try_to { @service_obj.introspect }
+        true
+      rescue
+        false
+      end
+    end
+
+    #returns values of attributes mapped to @supports
+    def method_missing(name, *args)
+      raise NoMethodError unless args.length == 0 and not block
+      m_data = name.match /^supports_([a-zA-Z]+)\?$/
+      raise NoMethodError unless m_data and m_data[1]
+      ( val = @supports[m_data[1]] ) and Notifications::VALID_CAPABILITIES.include?(m_data[1]) ? val : false
+    end
+
+    #returns notification after run
+    def send_notification(notify_temp, replace_previous=false)
+      ( replace_previous and notify_temp.id > 0 ) ? r_id = notify_temp.id : r_id = 0
+
+      id = try_to {
+        @service_obj.Notify( notify_temp.appname, r_id, notify_temp.icon, notify_temp.summary,
+                             notify_temp.body, notify_temp.actions.pack, notify_temp.hints,
+                             notify_temp.timeout )[0]
+      }
+
+      if not replace_previous then
+        notify_temp = notify_temp.clone
+      end
+
+      notify_temp.id = id
+      @last_notify = notify_temp
+      notify_temp
+    end
+
+    def close_notification(notify_temp=nil)
+      if notify_temp then
+        close = notify_temp
+      elsif @last_notify
+        close = @last_notify
+      else
+        return -1
+      end
+
+      try_to { @service_obj.CloseNotification(close.id)[0] }
+    end
+
+    def get_server_info
+      try_to { @service_obj.GetServerInformation }
+    end
+
+    private
+    def try_to(&block)
+      Timeout::timeout(TIMEOUT) { block.call }
+    end
+  end
+
+  class Action
+    attr_accessor :action, :action_string, :callback
+
+    def initialize(action, action_string, callback = nil)
+      @action = action
+      @action_string = action_string
+      @callback = callback
+    end
+
+    def normalize
+      [@action, @action_string]
+    end
+  end
+
+  class ActionList
+    def initialize(action_list = [])
+      @action_list = action_list
+    end
+
+    def <<(action)
+      @action_list << action
+    end
+
+    def [](id)
+      @action_list[id]
+    end
+
+    def length
+      @action_list.length
+    end
+
+    def pack
+      al = @action_list.map do |action|
+        action.normalize
+      end
+
+      al.flatten!
+      al
+    end
+  end
+
+  class Notification
+    attr_accessor :actions, :icon, :body, :summary, :hints, :timeout, :id, :appname
+
+    def initialize(icon: '', body: '', summary: '', hints: {}, timeout: -1, appname:)
+      @actions = ActionList.new
+      @icon = icon
+      @body = body
+      @summary = summary
+      @hints = hints
+      @timeout = timeout
+      @id = nil
+      @appname = appname
+    end
+
+    def register_action(action:)
+      @actions << action
+    end
+  end
+end

data/lib/ruby-notifications/version.rb

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

data/ruby-notifications.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby-notifications/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-notifications"
+  spec.version       = Notifications::VERSION
+  spec.authors       = ["David Young"]
+  spec.email         = ["david@davidyoung.space"]
+
+  spec.summary       = "Simple interface for the org.freedesktop.Notifications service."
+  spec.homepage      = "https://github.com/CrunchwrapSupreme/ruby-notifications.git"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "ruby-dbus", "~> 0.14.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ruby-notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Young
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: ruby-dbus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: 
+email:
+- david@davidyoung.space
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/notifications.rb
+- lib/ruby-notifications/version.rb
+- ruby-notifications.gemspec
+homepage: https://github.com/CrunchwrapSupreme/ruby-notifications.git
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Simple interface for the org.freedesktop.Notifications service.
+test_files: []