gir_ffi-gnome_keyring 0.0.1

data/Changelog.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2013-08-03
+
+* Initial release

data/README.md

@@ -0,0 +1,22 @@
+# GirFFI-GnomeKeyring
+
+GirFFI-based bindings for GnomeKeyring
+
+[![Build Status](https://secure.travis-ci.org/mvz/gir_ffi-gnome_keyring.png)](http://travis-ci.org/mvz/gir-ffi-gnome_keyring)
+
+## Features
+
+* Auto-generated bindings using GObject introspection.
+* Adds overrides for introspection data bugs.
+
+## Install
+
+    gem install gir_ffi-gnome_keyring
+
+## License
+
+Copyright © 2013 Matijs van Zuijlen
+
+GirFFI-GnomeKeyring is free software, distributed under the terms of the GNU
+Lesser General Public License, version 2.1 or later. See the file
+COPYING.LIB for more information.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/clean'
+import 'tasks/test.rake'
+import 'tasks/yardoc.rake'
+
+task :default => 'test'

data/lib/gir_ffi-gnome_keyring.rb

@@ -0,0 +1,57 @@
+require 'gir_ffi'
+
+GirFFI.setup 'GnomeKeyring'
+
+require 'gir_ffi-gnome_keyring/attribute'
+require 'gir_ffi-gnome_keyring/attribute_list'
+require 'gir_ffi-gnome_keyring/found'
+
+module GnomeKeyring
+  setup_method :find_items_sync
+  setup_method :item_create_sync
+  setup_method :item_get_attributes_sync
+  setup_method :item_set_attributes_sync
+
+  class << self
+    remove_method :find_items_sync
+    remove_method :item_create_sync
+    remove_method :item_set_attributes_sync
+    remove_method :item_get_attributes_sync
+  end
+
+  def self.find_items_sync(type, attributes)
+    _v2 = GnomeKeyring::AttributeList.from(attributes)
+    _v3 = GirFFI::InOutPointer.for(:glist)
+    _v4 = GnomeKeyring::Lib.gnome_keyring_find_items_sync(type, _v2, _v3)
+    _v5 = GLib::List.wrap(GnomeKeyring::Found, _v3.to_value)
+    return [_v4, _v5]
+  end
+
+  def self.item_create_sync(keyring, type, display_name, attributes, secret,
+                            update_if_exists)
+    _v1 = GirFFI::InPointer.from(:utf8, keyring)
+    _v3 = GirFFI::InPointer.from(:utf8, display_name)
+    _v4 = GnomeKeyring::AttributeList.from(attributes)
+    _v5 = GirFFI::InPointer.from(:utf8, secret)
+    _v7 = GirFFI::InOutPointer.for(:guint32)
+    _v8 = GnomeKeyring::Lib.gnome_keyring_item_create_sync(_v1, type, _v3, _v4,
+                                                           _v5,
+                                                           update_if_exists,
+                                                           _v7)
+    return [_v8, _v7.to_value]
+  end
+
+  def self.item_get_attributes_sync(keyring, id)
+    _v1 = GirFFI::InPointer.from(:utf8, keyring)
+    _v3 = GirFFI::InOutPointer.for(:struct)
+    _v4 = GnomeKeyring::Lib.gnome_keyring_item_get_attributes_sync(_v1, id, _v3)
+    attributes = GnomeKeyring::AttributeList.wrap(_v3.to_value)
+    return [_v4, attributes]
+  end
+
+  def self.item_set_attributes_sync(keyring, id, attributes)
+    _v1 = GirFFI::InPointer.from(:utf8, keyring)
+    _v3 = GnomeKeyring::AttributeList.from(attributes)
+    GnomeKeyring::Lib.gnome_keyring_item_set_attributes_sync(_v1, id, _v3)
+  end
+end

data/lib/gir_ffi-gnome_keyring/attribute.rb

@@ -0,0 +1,16 @@
+module GnomeKeyring
+  load_class :Attribute
+
+  class Attribute
+    setup_method 'list_new'
+    setup_method 'list_append_string'
+    setup_method 'list_append_uint32'
+
+    private_class_method :list_new,
+      :list_append_string,
+      :list_append_uint32,
+      :list_copy,
+      :list_free,
+      :list_to_glist
+  end
+end

data/lib/gir_ffi-gnome_keyring/attribute_list.rb

@@ -0,0 +1,46 @@
+require 'gir_ffi-gnome_keyring/attribute'
+
+module GnomeKeyring
+  class AttributeList < GLib::Array
+    def self.new
+      ptr = GnomeKeyring::Lib.gnome_keyring_attribute_list_new
+      wrap(ptr)
+    end
+
+    def self.wrap ptr
+      super GnomeKeyring::Attribute, ptr
+    end
+
+    def self.from it
+      case it
+      when self then it
+      when FFI::Pointer then wrap it
+      else self.new.tap {|arr| arr.append_vals it }
+      end
+    end
+
+    # FIXME: Remove once GLib::Array#index has been fixed
+    def index idx
+      ptr = @struct[:data] + idx * get_element_size
+      GnomeKeyring::Attribute.wrap(ptr)
+    end
+
+    def append_string name, value
+      _v2 = GirFFI::InPointer.from(:utf8, name)
+      _v3 = GirFFI::InPointer.from(:utf8, value)
+      GnomeKeyring::Lib.gnome_keyring_attribute_list_append_string self, _v2, _v3
+    end
+
+    def append_uint32 name, value
+      _v2 = GirFFI::InPointer.from(:utf8, name)
+      GnomeKeyring::Lib.gnome_keyring_attribute_list_append_uint32 self, _v2, value
+    end
+
+    private
+
+    # FIXME: Private method override. Bad.
+    def check_element_size_match
+      true
+    end
+  end
+end

data/lib/gir_ffi-gnome_keyring/found.rb

@@ -0,0 +1,17 @@
+require 'gir_ffi-gnome_keyring/attribute_list'
+
+module GnomeKeyring
+  load_class :Found
+
+  class Found
+    def attributes
+      struct = GnomeKeyring::Found::Struct.new(@struct.to_ptr)
+      GnomeKeyring::AttributeList.wrap(struct[:attributes])
+    end
+
+    def attributes=(value)
+      struct = GnomeKeyring::Found::Struct.new(@struct.to_ptr)
+      struct[:attributes] = GnomeKeyring::AttributeList.from(value)
+    end
+  end
+end

data/tasks/test.rake

@@ -0,0 +1,19 @@
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:unit) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/unit/**/*_test.rb']
+    t.ruby_opts += ["-w -Itest"]
+  end
+
+  Rake::TestTask.new(:integration) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/integration/*_test.rb']
+    t.ruby_opts += ["-w -Itest"]
+  end
+end
+
+desc 'Run unit and integration tests'
+task :test => ['test:unit', 'test:integration']

data/tasks/yardoc.rake

@@ -0,0 +1,9 @@
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--private', '--protected', '--readme',  'README.md']
+  end
+rescue LoadError
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'gir_ffi-gnome_keyring'

data/test/unit/gir_ffi-gnome_keyring/attribute_list_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+describe GnomeKeyring::AttributeList do
+  it "descends from GLib::Array" do
+    GnomeKeyring::AttributeList.ancestors.must_include GLib::Array
+  end
+
+  describe ".new" do
+    it "takes no arguments" do
+      GnomeKeyring::AttributeList.new
+      pass
+    end
+  end
+
+  describe ".wrap" do
+    it "wraps its argument in an AttributeList object" do
+      orig = GnomeKeyring::AttributeList.new
+      copy = GnomeKeyring::AttributeList.wrap(orig.to_ptr)
+      copy.to_ptr.must_equal orig.to_ptr
+    end
+  end
+
+  describe ".from" do
+    it "wraps its argument's pointer in an AttributeList object" do
+      orig = GnomeKeyring::AttributeList.new
+      copy = GnomeKeyring::AttributeList.from(orig)
+      copy.to_ptr.must_equal orig.to_ptr
+    end
+
+    it "wraps an empty array" do
+      attr = GnomeKeyring::AttributeList.from([])
+      attr.to_a.must_equal []
+    end
+
+    it "wraps an array of Attribute" do
+      att = GnomeKeyring::Attribute.new
+      att.name = 'foo'
+      attr = GnomeKeyring::AttributeList.from([att])
+      arr = attr.to_a
+      arr.length.must_equal 1
+      arr.first.name.must_equal 'foo'
+    end
+  end
+
+  describe "#append_string" do
+    it "appends a string attribute" do
+      list = GnomeKeyring::AttributeList.new
+      list.append_string 'foo', 'bar'
+      attr = list.index(0)
+      attr.name.must_equal 'foo'
+      attr.get_string.must_equal 'bar'
+      attr.type.must_equal :string
+    end
+  end
+
+  describe "#append_uint32" do
+    it "appends a uint32 attribute" do
+      list = GnomeKeyring::AttributeList.new
+      list.append_uint32 'baz', 42
+      attr = list.index(0)
+      attr.name.must_equal 'baz'
+      attr.get_uint32.must_equal 42
+      attr.type.must_equal :uint32
+    end
+  end
+end

data/test/unit/gir_ffi-gnome_keyring/attribute_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+describe GnomeKeyring::Attribute do
+  describe ".list_new" do
+    it "is private" do
+      proc { GnomeKeyring::Attribute.list_new }.must_raise NoMethodError
+    end
+  end
+
+  describe ".list_append_string" do
+    it "is private" do
+      proc { GnomeKeyring::Attribute.list_append_string }.must_raise NoMethodError
+    end
+  end
+
+  describe ".list_append_uint32" do
+    it "is private" do
+      proc { GnomeKeyring::Attribute.list_append_uint32 }.must_raise NoMethodError
+    end
+  end
+
+  describe ".list_copy" do
+    it "is private" do
+      proc { GnomeKeyring::Attribute.list_copy }.must_raise NoMethodError
+    end
+  end
+
+  describe ".list_free" do
+    it "is private" do
+      proc { GnomeKeyring::Attribute.list_free }.must_raise NoMethodError
+    end
+  end
+
+  describe ".list_to_glist" do
+    it "is private" do
+      proc { GnomeKeyring::Attribute.list_to_glist }.must_raise NoMethodError
+    end
+  end
+end

data/test/unit/gir_ffi-gnome_keyring/found_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe GnomeKeyring::Found do
+  let(:instance) { GnomeKeyring::Found.new }
+
+  describe "#attributes" do
+    it "returns nil by default" do
+      attrs = instance.attributes
+      attrs.must_be_nil
+    end
+
+    it "returns an assigned AttributeList" do
+      attrs = GnomeKeyring::AttributeList.new
+      struct = GnomeKeyring::Found::Struct.new(instance.to_ptr)
+      struct[:attributes] = attrs.to_ptr
+
+      result = instance.attributes
+      result.must_be_instance_of GnomeKeyring::AttributeList
+      result.to_ptr.must_equal attrs.to_ptr
+    end
+  end
+
+  describe "#attributes=" do
+    it "assigns its argument to the correct struct member" do
+      attrs = GnomeKeyring::AttributeList.new
+      instance.attributes = attrs
+      struct = GnomeKeyring::Found::Struct.new(instance.to_ptr)
+      result = struct[:attributes]
+      result.must_equal attrs.to_ptr
+    end
+  end
+end

data/test/unit/gir_ffi-gnome_keyring_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+describe GnomeKeyring do
+  describe ".find_items_sync" do
+    it "calls Lib.gnome_keyring_find_items_sync with the correct values" do
+      body = lambda { |type, attrs, listptr|
+        type.must_equal :generic_secret
+        attrs.must_be_instance_of GnomeKeyring::AttributeList
+        listptr.must_be_instance_of GirFFI::InOutPointer
+        :ok
+      }
+
+      GnomeKeyring::Lib.stub :gnome_keyring_find_items_sync, body do
+        code, list = GnomeKeyring.find_items_sync :generic_secret, []
+        code.must_equal :ok
+        list.must_be_nil
+      end
+    end
+  end
+
+  describe ".item_create_sync" do
+    it "calls Lib.gnome_keyring_item_create_sync with the correct values" do
+      body = lambda { |keyring, type, display_name, attributes, secret, update_if_exists, item_id|
+        GirFFI::ArgHelper.ptr_to_utf8(keyring).must_equal "foo"
+        type.must_equal :generic_secret
+        GirFFI::ArgHelper.ptr_to_utf8(display_name).must_equal "bar"
+        attributes.must_be_instance_of GnomeKeyring::AttributeList
+        GirFFI::ArgHelper.ptr_to_utf8(secret).must_equal "secret-name"
+        update_if_exists.must_equal false
+
+        item_id.write_int32 42
+        :ok
+      }
+
+      GnomeKeyring::Lib.stub :gnome_keyring_item_create_sync, body do
+        code, id = GnomeKeyring.item_create_sync("foo",
+                                                   :generic_secret,
+                                                   "bar",
+                                                   [],
+                                                   "secret-name",
+                                                   false)
+        code.must_equal :ok
+        id.must_equal 42
+      end
+    end
+  end
+
+  describe ".item_get_attributes_sync" do
+    it "calls Lib.gnome_keyring_item_get_attributes_sync with the correct values" do
+      body = lambda { |keyring, id, attributes|
+        GirFFI::ArgHelper.ptr_to_utf8(keyring).must_equal "foo"
+        id.must_equal 42
+        attributes.must_be_instance_of GirFFI::InOutPointer
+        :ok
+      }
+
+      GnomeKeyring::Lib.stub :gnome_keyring_item_get_attributes_sync, body do
+        code, list = GnomeKeyring.item_get_attributes_sync "foo", 42
+        code.must_equal :ok
+        list.must_be_nil
+      end
+    end
+  end
+
+  describe ".item_set_attributes_sync" do
+    it "calls Lib.gnome_keyring_item_set_attributes_sync with the correct values" do
+      body = lambda { |keyring, id, attributes|
+        GirFFI::ArgHelper.ptr_to_utf8(keyring).must_equal "foo"
+        id.must_equal 42
+        attributes.must_be_instance_of GnomeKeyring::AttributeList
+        :ok
+      }
+
+      GnomeKeyring::Lib.stub :gnome_keyring_item_set_attributes_sync, body do
+        result = GnomeKeyring.item_set_attributes_sync "foo", 42, []
+        result.must_equal :ok
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: gir_ffi-gnome_keyring
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matijs van Zuijlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gir_ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+description: 
+email:
+- matijs@matijs.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- Changelog.md
+files:
+- lib/gir_ffi-gnome_keyring.rb
+- lib/gir_ffi-gnome_keyring/attribute.rb
+- lib/gir_ffi-gnome_keyring/attribute_list.rb
+- lib/gir_ffi-gnome_keyring/found.rb
+- test/test_helper.rb
+- test/unit/gir_ffi-gnome_keyring_test.rb
+- test/unit/gir_ffi-gnome_keyring/found_test.rb
+- test/unit/gir_ffi-gnome_keyring/attribute_list_test.rb
+- test/unit/gir_ffi-gnome_keyring/attribute_test.rb
+- tasks/yardoc.rake
+- tasks/test.rake
+- Changelog.md
+- README.md
+- Rakefile
+homepage: http://www.github.com/mvz/gir_ffi-gnome_keyring
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+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.23
+signing_key: 
+specification_version: 3
+summary: GirFFI-based binding to GnomeKeyring
+test_files:
+- test/test_helper.rb
+- test/unit/gir_ffi-gnome_keyring/attribute_list_test.rb
+- test/unit/gir_ffi-gnome_keyring/attribute_test.rb
+- test/unit/gir_ffi-gnome_keyring/found_test.rb
+- test/unit/gir_ffi-gnome_keyring_test.rb
+has_rdoc: