bitmessage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b36761f53068136c1e4bb97eb7af896cbac07bf
+  data.tar.gz: b105955e147e26b6f64761583d98870c385e341a
+SHA512:
+  metadata.gz: 7afc55a36373519b094f600a80ac8fc93d653891c9117933c4dec1e917061ac0021d0302bfa3c08ab1b692e979c92068ed3b3a49624a1dc4e998df71513cc7e1
+  data.tar.gz: 5a639623ab8786f9f5adb063508810aeae86bc3cdd45fffdbfc65271dc4148b48ddf669a8273a3b987ee2fb483efb1a516e8b8a448a75ab690d0c4949d072652

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 bitmessage.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2013 Robert Nasiadek
+Copyright (c) 2013 Adam Thorsen
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Thorsen
+
+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,47 @@
+## Bitmessage API Ruby Wrapper
+
+Thin API wrapper for the official BitMessage Python client.  This gem is based on the [original library](https://github.com/robzon/bitmessage-api-ruby) 
+created by [robzon](https://github.com/robzon).
+
+## Requirements
+
+Running [Bitmessage client](https://github.com/Bitmessage/PyBitmessage) with API enabled.
+
+## Usage
+
+    require 'bitmessage'
+
+    api = Bitmessage::ApiClient.new 'http://user:password@host:port/'
+
+    api.add 3, 5
+
+### Getting a list of messages
+
+    inbox = api.get_all_inbox_messages
+    
+    puts "You have #{inbox.count} messages:"
+
+    inbox.each do |msg|
+      puts "#{msg.msgid}  #{msg.from}  #{msg.subject}"
+    end
+
+### Sending a message
+
+
+    to = "BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb" # echo service
+    from = api.list_addresses.first.address
+
+    api.send_message to, from, "This is subject", "This is message"
+
+### Running the tests
+
+    For tests to to pass it is necessary to set the BM_URI environment
+    variable.  For example:
+
+    BM_URI=http://user:password@host:port/ rake test
+
+## FAQ
+
+Q: Does this cover 100% of the API?
+
+A: Not yet.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/bitmessage'
+  t.test_files = FileList['test/lib/bitmessage/*_test.rb']
+end
+
+desc "Run tests"
+task :default => :test

data/bitmessage.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitmessage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitmessage"
+  spec.version       = Bitmessage::VERSION
+  spec.authors       = ["Adam Thorsen"]
+  spec.email         = ["awt@fastmail.fm"]
+  spec.description   = %q{This gem provides an client library for the PyBitmessage API.}
+  spec.summary       = %q{This gem allows listing, sending, generating, etc messages via the Bitmessage protocol.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/bitmessage.rb

@@ -0,0 +1,6 @@
+require "bitmessage/version"
+require "bitmessage/api_client"
+
+module Bitmessage
+  # Your code goes here...
+end

data/lib/bitmessage/api_client.rb

@@ -0,0 +1,171 @@
+require 'xmlrpc/client'
+require 'json'
+require 'base64'
+
+module Bitmessage
+  class ApiClient
+    class Address
+      attr_accessor :label, :address, :stream, :enabled
+
+      def initialize hash, label_encoded = false
+        self.label = label_encoded ? Base64.decode64(hash['label']) : hash['label']
+        self.address = hash['address']
+        self.stream = hash['stream'] if hash.keys.include?('stream')
+        self.enabled = hash['enabled']
+      end
+
+      def to_s
+        "#{self.label} (#{self.address})"
+      end
+    end
+
+    class Message
+      ENCODING_IGNORE = 0
+      ENCODING_TRIVIAL = 1
+      ENCODING_SIMPLE = 2
+
+      FOLDER_UNKNOWN = :unknown
+      FOLDER_INBOX = :inbox
+      FOLDER_OUTBOX = :outbox
+
+      # common attributes
+      attr_accessor :msgid, :to, :from, :subject, :message, :encoding, :folder
+      # inbox attributes
+      attr_accessor :read, :received_at
+      # outbox attributes
+      attr_accessor :last_action_at, :status, :ack_data
+
+      def initialize hash
+        self.folder = FOLDER_UNKNOWN
+        self.msgid = hash['msgid']
+        self.to = hash['toAddress']
+        self.from = hash['fromAddress']
+        self.subject = Base64.decode64(hash['subject'])
+        self.message = Base64.decode64(hash['message'])
+        self.encoding = hash['encodingType'].to_i
+
+        if hash.keys.include?('receivedTime')
+          self.folder = FOLDER_INBOX
+          self.received_at = Time.at(hash['receivedTime'].to_i)
+          self.read = hash['read'] == 0 ? false : true
+        elsif hash.keys.include?('ackData')
+          self.folder = FOLDER_OUTBOX
+          self.last_action_at = Time.at(hash['lastActionTime'].to_i)
+          self.status = hash['status']
+          self.ack_data = hash['ackData']
+        end
+      end
+
+      def to_s
+        self.msgid
+      end
+    end
+
+    def initialize uri
+      @client = XMLRPC::Client.new_from_uri(uri)
+    end
+
+    # Returns the sum of the integers. Used as a simple test of the API.
+    def add a, b
+      @client.call('add', a, b)
+    end
+
+    # Returns 'first_word-second_word'. Used as a simple test of the API.
+    def hello_world first_word, second_word
+      @client.call('helloWorld', first_word, second_word)
+    end
+
+    # Displays the message in the status bar on the GUI
+    def status_bar text
+      @client.call('statusBar', text)
+    end
+
+    # Lists all addresses
+    def list_addresses
+      json = JSON.parse(@client.call('listAddresses'))
+
+      json['addresses'].map do |j|
+        Address.new j
+      end
+    end
+
+    # Creates one address using the random number generator.
+    def create_random_address label, eighteen_byte_ripe = false, total_difficulty = 1, small_message_difficulty = 1
+      @client.call(
+        'createRandomAddress',
+        Base64.encode64(label),
+        eighteen_byte_ripe,
+        total_difficulty,
+        small_message_difficulty)
+    end
+
+    # Does not include trashed messages.
+    def get_all_inbox_messages
+      json = JSON.parse(@client.call('getAllInboxMessages'))
+      json['inboxMessages'].map do |j|
+        Message.new j
+      end
+    end
+    
+    def get_inbox_message_by_id msgid
+      hash = JSON.parse(@client.call('getInboxMessageById', msgid))
+      Message.new hash['inboxMessage'].first
+    end
+
+    def get_all_sent_messages
+      json = JSON.parse(@client.call('getAllSentMessages'))
+      json['sentMessages'].map do |j|
+        Message.new j
+      end
+    end
+
+    def get_sent_message_by_id msgid
+      hash = JSON.parse(@client.call('getSentMessageById', msgid))
+      Message.new hash['sentMessage'].first
+    end
+
+    def get_sent_message_by_ack_data ack_data
+      hash = JSON.parse(@client.call('getSentMessageByAckData', ack_data))
+      Message.new hash['sentMessage'].first
+    end
+
+    def get_sent_messages_by_sender sender
+      json = JSON.parse(@client.call('getSentMessagesBySender', sender))
+      json['sentMessages'].map do |j|
+        Message.new j
+      end
+    end
+
+    def trash_message msgid
+      @client.call('trashMessage', msgid)
+    end
+
+    def send_message to, from, subject, message, encoding = Message::ENCODING_SIMPLE
+      @client.call('sendMessage', to, from, Base64.encode64(subject), Base64.encode64(message), encoding)
+    end
+
+    def get_status ack_data
+      @client.call('getStatus', ack_data)
+    end
+
+    def send_broadcast from, subject, message, encoding = Message::ENCODING_SIMPLE
+      @client.call('sendBroadcast', from, Base64.encode64(subject), Base64.encode64(message), encoding)
+    end
+
+    def add_subscription address, label = ""
+      @client.call('addSubscription', address, Base64.encode64(label))
+    end
+
+    def delete_subscription address
+      @client.call('deleteSubscription', address)
+    end
+
+    def list_subscriptions
+      hash = JSON.parse(@client.call('listSubscriptions'))
+
+      hash['subscriptions'].map do |s|
+        Address.new s, true
+      end
+    end
+  end
+end

data/lib/bitmessage/version.rb

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

data/test/lib/bitmessage/bitmessage_test.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require_relative '../../test_helper'
+class BitmessageTest < Test::Unit::TestCase
+  def test_get_messages
+    api = Bitmessage::ApiClient.new ENV['BM_URI']
+    result = api.add 1, 1
+    assert_equal 2, result
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/bitmessage.rb', __FILE__)
+require 'pp'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: bitmessage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Thorsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: This gem provides an client library for the PyBitmessage API.
+email:
+- awt@fastmail.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitmessage.gemspec
+- lib/bitmessage.rb
+- lib/bitmessage/api_client.rb
+- lib/bitmessage/version.rb
+- test/lib/bitmessage/bitmessage_test.rb
+- test/test_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: This gem allows listing, sending, generating, etc messages via the Bitmessage
+  protocol.
+test_files:
+- test/lib/bitmessage/bitmessage_test.rb
+- test/test_helper.rb