s2d 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steffen Uhlig
+
+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,59 @@
+s2d - Send to Device
+====================
+
+Send text and documentation from the command line to various devices.
+
+Examples
+--------
+  - Found an interesting URL that I want to have on my iPhone
+  - Send the PDF I just produced to my iPad
+  - Send a file to my Kindle
+
+User Interface
+--------------
+I am mostly working on the command line, therefore I want something that works as pipe:
+
+    cat file.txt | 2iphone
+    2iphone file.txt
+    2kindle book.mobi
+    2ipad document.pdf
+
+All of these commands are actualy aliased versions of the `s2d` command:
+
+    # assuming that s2d has a device called 'iPhone' configured
+    alias 2iphone="s2d --device=iPhone"
+    alias 2kindle="s2d --device=Kindle"
+    alias 2ipad="s2d --device=iPad"
+
+Concepts
+========
+
+Target Device
+-------------
+Identifies a device. Holds device name and transport. Examples names are 'iPhone', 'MyKindle' or 'Paula's iPad'.
+
+Transport
+---------
+A transport defines how to reach a device and holds all information required to reach it:
+
+  * [Prowl](http://www.prowlapp.com/) (for iPhone/iPad)
+
+Not implemented yet:
+
+  * Mail
+  * SMS
+  * Twitter DM
+  * Custom (potentially requires a device-specific app e.g. on the iPhone)
+
+Delivery Strategy
+-----------------
+Belongs to a transport.
+
+* iPhone & iPad
+  - Smaller text, URLs, etc: Send directly
+  - Larger files: Upload to Dropbox and send private link
+  - Limit probably needs configuration
+
+* Kindle
+  - File attachment of an eMail. s2d will create one if input was passed as pipe.
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/s2d

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.require
+
+def die(msg, code = 1)
+  STDERR.puts(msg)
+  exit(code)
+end
+
+# TODO Add wizard for initial device config
+# TODO Add parameters for selecting the default device
+
+device = 'iPhone' # TODO Add --device parameter
+verbose = true    # TODO Add --verbose parameter
+
+if device
+  target = S2D::Configuration::Repository.instance.device(device.to_sym)
+  die("No device #{device} not configured") if target.nil?
+else
+  target = S2D::Configuration::Repository.instance.active_device
+  die("No active device configured") if target.nil?
+end
+
+message = S2D::Message.new
+
+if ARGV.size > 0
+  message.body = ARGV.join(' ')
+else
+  puts 'Type your message and end with Control-D.' if verbose && STDIN.tty?
+  message.body = ARGF.read
+end
+
+if message.invalid?
+  die('Invalid message') # TODO Add message.errors from ActiveSupport::Validations
+else
+  begin
+    puts "Delivering your message via #{target.transport}" if verbose
+    target.deliver(message)
+    puts "Done." if verbose
+  rescue
+    if verbose
+      die($!.backtrace.join('\n'))
+    else
+      die($!.message)
+    end
+  end
+end

data/lib/s2d.rb

@@ -0,0 +1,20 @@
+require 'prowler'
+require 'active_support/inflector'
+
+require 's2d/version'
+
+require 's2d/configuration/attribute'
+require 's2d/configuration/repository'
+
+require 's2d/device'
+require 's2d/message'
+
+require 's2d/transports/transport'
+require 's2d/transports/prowler'
+
+require 's2d/mappers/device_mapper'
+require 's2d/mappers/transport_mapper'
+
+module S2D
+  # Your code goes here...
+end

data/lib/s2d/configuration/attribute.rb

@@ -0,0 +1,33 @@
+module S2D
+  module Configuration
+    class Attribute
+      attr_reader :key, :description
+
+      protected
+
+      def initialize(mandatory, key, description)
+        @mandatory, @key, @description = mandatory, key, description
+      end
+
+      def mandatory?
+        @mandatory
+      end
+    end
+
+    class MandatoryAttribute < Attribute
+      def initialize(key, description)
+        super(true, key, description)
+      end
+    end
+
+    class OptionalAttribute < Attribute
+      attr_reader :default_value
+
+      def initialize(key, description, default_value)
+        super(false, key, description)
+        @default_value = default_value
+      end
+    end
+  end
+end
+

data/lib/s2d/configuration/repository.rb

@@ -0,0 +1,74 @@
+require 'singleton'
+require 'yaml'
+
+module S2D
+  module Configuration
+    class Repository
+      include Singleton
+
+      attr_reader :path
+
+      def initialize
+        @path = File.join(File.expand_path('~'), FILE_NAME)
+        @data = load
+      end
+
+      def load
+        YAML.load_file(@path)
+      rescue Errno::ENOENT
+        default_structure
+      end
+
+      def devices
+        @data[:devices].keys
+      end
+
+      def device(key)
+        selected = @data[:devices][key]
+
+        if selected.nil?
+          nil
+        else
+          Mappers::DeviceMapper.to_object(selected)
+        end
+      end
+
+      def add_device(device, activate = false)
+        @data[:devices][device.name.to_sym] = Mappers::DeviceMapper.to_hash(device)
+        self.active_device = device if activate
+        write
+      end
+
+      def active_device
+        device(:default)
+      end
+
+      def active_device=(device)
+        add_device(device, false) unless device(device.name.to_sym)
+        @data[:devices][:default] = device.name.to_sym
+        write
+      end
+
+      def empty?
+        @data == default_structure
+      end
+
+      def reset
+        self.send(:initialize)
+      end
+
+    private
+      FILE_NAME = '.s2drc'
+
+      def default_structure
+        { :devices => {}}
+      end
+
+      def write
+        File.open(@path, File::RDWR|File::TRUNC|File::CREAT, 0600) do |rcfile|
+          rcfile.write(@data.to_yaml)
+        end
+      end
+    end
+  end
+end

data/lib/s2d/device.rb

@@ -0,0 +1,13 @@
+module S2D
+  class Device
+    extend Forwardable
+    def_delegator :transport, :deliver
+
+    attr_reader :name
+    attr_accessor :transport
+
+    def initialize(name)
+      @name = name
+    end
+  end
+end

data/lib/s2d/disable_peer_verification.rb

@@ -0,0 +1,2 @@
+require 'openssl'
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE

data/lib/s2d/mappers/device_mapper.rb

@@ -0,0 +1,20 @@
+module S2D
+  module Mappers
+    class DeviceMapper
+      class << self
+        def to_hash(device)
+          {}.tap do |h|
+            h[:name] = device.name
+            h[:transport] = TransportMapper.to_hash(device.transport)
+          end
+        end
+
+        def to_object(h)
+          Device.new(h[:name]).tap do |d|
+            d.transport = TransportMapper.to_object(h[:transport])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/s2d/mappers/transport_mapper.rb

@@ -0,0 +1,18 @@
+module S2D
+  module Mappers
+    class TransportMapper
+      class << self
+        def to_hash(transport)
+          {}.tap do |h|
+            h[:name]   = transport.class
+            h[:config] = transport.config
+          end
+        end
+
+        def to_object(h)
+          h[:name].new(h[:config])
+        end
+      end
+    end
+  end
+end

data/lib/s2d/message.rb

@@ -0,0 +1,17 @@
+module S2D
+  class Message
+    attr_accessor :subject, :body
+
+    def initialize(subject = "from #{%x[hostname].chomp}:", body = nil)
+      @subject, @body = subject, body
+    end
+
+    def valid?
+      valid?
+    end
+
+    def invalid?
+      @subject.nil? || @body.nil? || @subject.empty? || @body.empty?
+    end
+  end
+end

data/lib/s2d/repository.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+require 'yaml'
+
+module S2D
+  module Configuration
+    class Repository
+      include Singleton
+
+      attr_reader :path
+
+      def initialize
+        @path = File.join(File.expand_path('~'), FILE_NAME)
+        @data = load
+      end
+
+      def load
+        YAML.load_file(@path)
+      rescue Errno::ENOENT
+        default_structure
+      end
+
+      def add_device(device, activate = false)
+        @data[:devices][device.name.to_sym] = Mappers::DeviceMapper.to_hash(device)
+        self.active_device = device if activate
+        write
+      end
+
+      def active_device
+        default = devices[:default]
+
+        if default.nil?
+          raise "No default device configured"
+        else
+          device(default)
+        end
+      end
+
+      def active_device=(device)
+        devices[:default] = device.name.to_sym
+        write
+      end
+
+      def empty?
+        @data == default_structure
+      end
+
+      def reset
+        self.send(:initialize)
+      end
+
+    private
+      FILE_NAME = '.s2drc'
+
+      def default_structure
+        { :devices => {}}
+      end
+
+      def write
+        File.open(@path, File::RDWR|File::TRUNC|File::CREAT, 0600) do |rcfile|
+          rcfile.write(@data.to_yaml)
+        end
+      end
+    end
+  end
+end

data/lib/s2d/transports/prowler.rb

@@ -0,0 +1,27 @@
+module S2D
+  module Transports
+    class Prowler < Transport
+      include S2D::Configuration
+
+      def initialize(config)
+        super(config)
+        ::Prowler.logger.level = Logger::WARN
+        @prowler = ::Prowler.new(:application => $0, :api_key => config[:api_key])
+      end
+
+      def deliver(message)
+        @prowler.notify(message.subject, message.body)
+      end
+
+      #
+      # Config wizard uses this information to collect required and optional
+      # config parameters
+      #
+      def attributes
+        [ MandatoryAttribute.new(:api_key, 'API key for prowlapp.com'),
+          OptionalAttribute.new(:application, 'Application name to be passed to Prowl', $0),
+        ]
+      end
+    end
+  end
+end

data/lib/s2d/transports/transport.rb

@@ -0,0 +1,27 @@
+module S2D
+  module Transports
+    class Transport
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def deliver(message)
+        raise "Transport class #{self.class} does not implement #deliver(message)"
+      end
+
+      #
+      # Config wizard uses this information to collect required and optional
+      # config parameters
+      #
+      def attributes
+        []
+      end
+
+      def to_s
+        self.class.name.demodulize
+      end
+    end
+  end
+end

data/lib/s2d/version.rb

@@ -0,0 +1,3 @@
+module S2D
+  VERSION = "0.0.1"
+end

data/s2d.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/s2d/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nicholas E. Rabenau"]
+  gem.email         = ["nerab@gmx.at"]
+  gem.description   = %q{Send text and documents to various mobile devices from the command line.}
+  gem.summary       = %q{s2d - Send to Device}
+  gem.homepage      = "http://github.com/nerab/s2d"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "s2d"
+  gem.require_paths = ["lib"]
+  gem.version       = S2D::VERSION
+
+  gem.add_dependency 'prowler', '~> 1.3'
+  gem.add_dependency 'activesupport', '~> 3.2'
+
+  gem.add_development_dependency 'guard-test', '~> 0.5'
+  gem.add_development_dependency 'guard-bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: s2d
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nicholas E. Rabenau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prowler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send text and documents to various mobile devices from the command line.
+email:
+- nerab@gmx.at
+executables:
+- s2d
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/s2d
+- lib/s2d.rb
+- lib/s2d/configuration/attribute.rb
+- lib/s2d/configuration/repository.rb
+- lib/s2d/device.rb
+- lib/s2d/disable_peer_verification.rb
+- lib/s2d/mappers/device_mapper.rb
+- lib/s2d/mappers/transport_mapper.rb
+- lib/s2d/message.rb
+- lib/s2d/repository.rb
+- lib/s2d/transports/prowler.rb
+- lib/s2d/transports/transport.rb
+- lib/s2d/version.rb
+- s2d.gemspec
+homepage: http://github.com/nerab/s2d
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: s2d - Send to Device
+test_files: []