motion-unixsocket 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6441edd9d5c8e6390b3b605591401f5c1ed24bc2
+  data.tar.gz: 03fde8297f247caeba8d68feb6f574b807cfc48e
+SHA512:
+  metadata.gz: 04087fa399915a1c3911b3f614ec49e7517a0cd74fc36575cff33e6fc7fa50b3160d888e82262ba2be4ca924599702148264588b0be933834118c12b9788b576
+  data.tar.gz: f6173057c03d85e7ef6bf14eeb0dbb37884557695dcd522e0abbaaca7e74fe9c334d9b18e6d1848db97da911c2aa26340b94a2ffc5d7efcbaffc722c45c5a79f

data/.gitignore

@@ -0,0 +1,19 @@
+.repl_history
+build
+tags
+app/pixate_code.rb
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+.DS_Store
+nbproject
+.redcar
+#*#
+*~
+*.sw[po]
+.eprj
+.sass-cache
+.idea
+.dat*.*
+sock
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: objective-c
+before_install:
+    - sudo chown -R travis ~/Library/RubyMotion
+    - mkdir -p ~/Library/RubyMotion/build
+
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Marcus Gartner
+
+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,72 @@
+Motion-UNIXSocket
+=================
+
+RubyMotion doesn't provide the convenient UNIXSocket class for interacting with
+Unix domain sockets. Motion-UNIXSocket is a replacement for UNIXSocket built
+on top of C's socket library and Objective-C's NSFileHandle.
+
+Installation
+------------
+
+Add this to your Gemfile:
+
+```
+gem "motion-unixsocket", "~> 0.0.1"
+```
+
+Run bundle install:
+
+```
+$ bundle install
+```
+
+Usage
+-----
+
+You can communicate with Unix domain sockets synchronously by reading and
+writing NSData objects.
+
+```ruby
+sock = UNIX::Socket.new('/path/to/socket')
+msg = "Put a sock in it!\n"
+sock.write(msg.to_data)
+
+response = sock.read
+puts NSString.stringWithUTF8String(response.bytes)
+# => "Some message sent back."
+```
+
+You can read from the socket asynchronously by passing a block to the constructor.
+
+```ruby
+sock = UNIX::Socket.new('/path/to/socket') do |data|
+  puts data # => prints and NSData object
+end
+
+msg = "Put a sock in it!\n"
+sock.write(msg.to_data)
+```
+
+Support
+-------
+
+I've only tested this gem on OS X.
+
+Status
+------
+
+This gem is very young and I'm sure there's some unknown bugs and gotchas. I'll try to fix any issues brought up, but pull requests for bug fixes, optimizations, and API changes are always welcome.
+
+Ideally the UNIX::Socket class would inherit from IO, but when I tried to piece together what methods needed to be implemented to get the full features of IO, I nearly lost my mind. If anyone can point me in the right direction for this, please let me know.
+
+Tests
+-----
+
+Writing tests for this was a bit tricky. I ended up using an MRI Ruby process to create a socket server. Each test spawns this simple Unix domain socket server which echos a message sent to it and then closes. The tests check that the value written to the socket via UNIX::Socket (RubyMotion version) is the same as the value read back.
+
+I was unable to get the asynchronous version working in the tests, but it works fine in an application and in the REPL.
+
+License
+-------
+
+MIT License

data/Rakefile

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project/template/osx'
+
+begin
+  require 'bundler'
+  Bundler.require
+rescue LoadError
+end
+
+Motion::Project::App.setup do |app|
+  app.name = 'motion-unixsocket'
+
+  app.include 'sys/socket.h'
+  app.include 'sys/un.h'
+end

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def applicationDidFinishLaunching(notification)
+    return true if RUBYMOTION_ENV == 'test'
+  end
+end

data/lib/motion-unixsocket.rb

@@ -0,0 +1,15 @@
+require 'unix/version'
+require 'motion.h'
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.dirname(__FILE__), "unix/**/*.rb")).each do |file|
+    app.files.unshift(file)
+  end
+
+  app.include 'sys/socket.h'
+  app.include 'sys/un.h'
+end

data/lib/unix/socket.rb

@@ -0,0 +1,86 @@
+# A UNIXSocket can interact as a client with Unix domain sockets.
+module UNIX
+  class Socket
+
+    # Creates a new Unix socket connection.
+    def initialize(path, &block)
+      @path = path
+      @addr = socket_addr(@path)
+      @on_read = block
+      connect
+    end
+
+    # Reads available data on the communication channel and returns it as an
+    # NSData object. If no data is available, the method blocks.
+    def read
+      data = @handle.availableData
+      return data
+    end
+
+    # Writes the given data to the socket.
+    def write(data)
+      @handle.writeData(data)
+    end
+
+    # Closes the socket connection.
+    def close
+      @handle.closeFile
+      @handle = nil
+    end
+
+    # Cleans up the socket.
+    def dealloc
+      notification_center.removeObserver(self)
+      close
+      super
+    end
+
+    private
+
+    # Returns a pointer to a Sockaddr corresponding to the given path.
+    def socket_addr(path)
+      addr = Sockaddr_un.new
+      addr.sun_family = AF_UNIX
+      path.each_char.each_with_index do |c, i|
+        addr.sun_path[i] = c
+      end
+      addr.sun_len = Type.sizeof(Sockaddr_un.type)
+      addr_ptr = Pointer.new(Sockaddr_un.type, 1)
+      addr_ptr[0] = addr
+      addr_ptr.cast!(Sockaddr.type)
+      return addr_ptr
+    end
+
+    # Connects to the socket.
+    # When the socket is read from, the on_read callback will be called.
+    def connect
+      @sockfd = socket(AF_UNIX, SOCK_STREAM, 0)
+      connect(@sockfd, @addr, @addr.value.sa_len)
+      @handle = NSFileHandle.alloc.initWithFileDescriptor(@sockfd)
+
+      if @on_read
+        notification_center.addObserver(self, selector: "msg_received:",
+                                        name: NSFileHandleReadCompletionNotification,
+                                        object: @handle)
+        @handle.readInBackgroundAndNotify
+      end
+    end
+
+    # Called when an asynchronous message is received on the socket.
+    # Passes the data on the communication channel to the block provided.
+    def msg_received(notification)
+      data = notification.userInfo.objectForKey(NSFileHandleNotificationDataItem)
+      if data.length > 0
+        NSLog("msg_received")
+        @on_read.call(data)
+      end
+      @handle.readInBackgroundAndNotify
+    end
+
+    # Returns the default notification center.
+    def notification_center
+      NSNotificationCenter.defaultCenter
+    end
+
+  end
+end

data/lib/unix/type.rb

@@ -0,0 +1,16 @@
+# Contains helper methods for C-struct types.
+module UNIX
+  module Type
+    extend self
+
+    # Returns the size of a C-struct type.
+    # A replacement for C's sizeof() function.
+    def sizeof(type)
+      size_ptr = Pointer.new(:ulong_long)
+      align_ptr = Pointer.new(:ulong_long)
+      NSGetSizeAndAlignment(type, size_ptr, align_ptr)
+      size_ptr[0]
+    end
+
+  end
+end

data/lib/unix/version.rb

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

data/motion-unixsocket.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/unix/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marcus Gartner"]
+  gem.email         = ["magartner@gmail.com"]
+  gem.description   = "A Unix domain socket library for RubyMotion."
+  gem.summary       = "A Unix domain socket library for RubyMotion."
+  gem.license       = "MIT"
+  gem.homepage      = "https://github.com/mgartner/motion-unixsocket"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "motion-unixsocket"
+  gem.require_paths = ["lib"]
+  gem.version       = UNIX::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_dependency 'motion.h', '~> 0.0.4'
+end

data/spec/type_spec.rb

@@ -0,0 +1,15 @@
+describe UNIX::Type do
+
+  describe "#sizeof" do
+    it "returns the size of a bool" do
+      UNIX::Type.sizeof('B').should == 1
+    end
+    it "returns the size of an int" do
+      UNIX::Type.sizeof('i').should == 4
+    end
+    it "returns the size of a sockaddr_un" do
+      UNIX::Type.sizeof(Sockaddr_un.type).should == 106
+    end
+  end
+
+end

data/spec/unixsocket_spec.rb

@@ -0,0 +1,40 @@
+describe UNIX::Socket do
+
+  SOCKET_FILE = File.expand_path('../../sock', __FILE__)
+
+  before do
+    system("rm #{SOCKET_FILE}")
+  end
+
+  context "without a block given to the initializer" do
+    it "should write and read data from the socket" do
+      message = "hello\n"
+      Process.spawn("ruby spec_helpers/echo.rb")
+      sleep(0.5)
+      s = UNIX::Socket.new(SOCKET_FILE)
+      s.write(message.to_data)
+      data = s.read
+      response = NSString.stringWithUTF8String(data.bytes)
+      response.should == message
+    end
+  end
+
+  # TODO: I can't seem to get these tests working. UNIX::Socket works fine with
+  # a block when I use it in the REPL, so this is weird.
+  # context "with a block given to the initializer" do
+  #   it "should write and read data from the socket" do
+  #     message = "hello\n"
+  #     #Process.spawn("ruby spec_helpers/echo.rb")
+  #     sleep(0.5)
+  #     response = nil
+  #     s = UNIX::Socket.new(SOCKET_FILE) do |data|
+  #       puts data
+  #       response = NSString.stringWithUTF8String(data.bytes)
+  #     end
+  #     s.write(message.to_data)
+  #     sleep(1)
+  #     response.should == message
+  #   end
+  # end
+
+end

data/spec_helpers/echo.rb

@@ -0,0 +1,7 @@
+require 'socket'
+
+UNIXServer.open("sock") do |server|
+  s = server.accept
+  msg = s.readline
+  s.puts msg
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: motion-unixsocket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcus Gartner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: motion.h
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+description: A Unix domain socket library for RubyMotion.
+email:
+- magartner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion-unixsocket.rb
+- lib/unix/socket.rb
+- lib/unix/type.rb
+- lib/unix/version.rb
+- motion-unixsocket.gemspec
+- spec/type_spec.rb
+- spec/unixsocket_spec.rb
+- spec_helpers/echo.rb
+homepage: https://github.com/mgartner/motion-unixsocket
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Unix domain socket library for RubyMotion.
+test_files:
+- spec/type_spec.rb
+- spec/unixsocket_spec.rb