smartcard 0.3.1 → 0.3.2

data/BUILD

@@ -1,18 +1,20 @@
 = Builds are hard
-+smartcard+ needs to talk to hardware (card readers), so it's bound to use a Ruby extension.
-This means C, and platform-specific building nightmares. Read below for details.
++smartcard+ needs to talk to hardware (card readers), so it's bound to use a
+Ruby extension. This means C, and platform-specific building nightmares.
+Read below for details.
 
 = The build system
-+smartcard+ uses {echoe}[http://blog.evanweaver.com/files/doc/fauna/echoe/] for builds. This
-automates most of the building and packaging work, and can even push the gem to rubyforge,
-with a bit of luck. Most used commands:
++smartcard+ uses {echoe}[http://blog.evanweaver.com/files/doc/fauna/echoe/] for
+builds. This automates most of the building and packaging work, and can even
+push the gem to rubyforge, with a bit of luck. Most used commands:
 	rake manifest # builds the manifest (do this after checking out)
 	rake package # builds the gem for your platform
 	rake mswin package # cross-builds the gem for Windows
 	rake test # builds the gem and runs the tests
 	rake docs # runs Rdoc to produce the docs
 
-On the other hand, you have to <tt>gem install echoe</tt> to be able to build anything.
+On the other hand, you have to <tt>gem install echoe</tt> to be able to build
+anything.
 
 = Platform-specific information
 
@@ -20,14 +22,17 @@ On the other hand, you have to <tt>gem install echoe</tt> to be able to build an
 
 You need to install the Developer Tools to get gcc.
 
-Leopard includes a working PC/SC provider, as well as a good driver for CCID readers.
-Tiger's PC/SC implementation is broken and incomplete, so the Ruby extension code in +smartcard+
-has a few hacks to work around that (look for the <tt>RB_SMARTCARD_OSX_TIGER_HACK</tt> define.
-The following commands are broken / don't work:
+Leopard (OSX 10.5) includes a working PC/SC provider, as well as a good driver
+for CCID readers.
+
+Tiger's (OSX 10.4) PC/SC implementation is broken and incomplete, so the Ruby
+extension code in +smartcard+ has a few hacks to work around that (look for the
+<tt>RB_SMARTCARD_OSX_TIGER_HACK</tt> define. The following commands are broken /
+don't work:
 * Smartcard::PCSC::Context#is_valid (always returs +true+)
-* Smartcard::PCSC::Card#get_attribute (throws exception because it's not implemented)
-* Smartcard::PCSC::Card#set_attribute (throws exception because it's not implemented)
-* Smartcard::PCSC::Card#control (Tiger's API is broken, so the call will probably not work)
+* Smartcard::PCSC::Card#get_attribute (not implemented, throws exception)
+* Smartcard::PCSC::Card#set_attribute (not implemented, throws exception)
+* Smartcard::PCSC::Card#control (Tiger's API is broken, the call may not work)
 
 The developer team doesn't support or test against ports of +gcc+ or +pcsclite+,
 but we success notifications are welcome.
@@ -37,29 +42,36 @@ but we success notifications are welcome.
 A lot of effort has been spent to make Windows builds as easy as possible.
 +smartcard+ is currently built using a full edition of
 {Visual Studio 2005}[http://msdn.microsoft.com/vstudio/], but all sources
-indicate that {Visual C++ Express 2005}[http://www.microsoft.com/express/download/] works,
-as long as you also install a Windows SDK (you're on your own for that). Visual Studio 2008
-might work, but it hasn't been tested yet.
+indicate that
+{Visual C++ Express 2005}[http://www.microsoft.com/express/download/]
+works, as long as you also install a Windows SDK (you're on your own for that).
+Visual Studio 2008 might work, but it hasn't been tested yet.
 
 A summary of the hacks that have been done to get Windows builds working:
-* removing the extension files from the gemspec at the "right time" so that +echoe+ compiles the extension, and the gem doesn't require re-compilation (see the +Rakefile+)
+* removing the extension files from the gemspec at the "right time" so that
++echoe+ compiles the extension, and the gem doesn't require re-compilation (see
+the +Rakefile+)
 * adding the compiled extension to the file list in the gemspec
-* adding code to <tt>extconf.rb</tt> to patch the +Makefile+ so a manifest is embedded in the extension dll (and ruby doesn't crash if it uses a different version of the C runtime)
+* adding code to <tt>extconf.rb</tt> to patch the +Makefile+ so a manifest is
+embedded in the extension dll (and ruby doesn't crash if it uses a different
+version of the C runtime)
 
 == Linux
 
 +smartcard+ is developed (and tested) against the
-{MUSCLE project}[http://www.linuxnet.com/software.html]. If you go this route, you need to
-get at least the {pcsclite library}[http://pcsclite.alioth.debian.org/] and a driver.
-+smartcard+ developers use the {CCID driver}[http://pcsclite.alioth.debian.org/], which
-works on most (new) readers.
+{MUSCLE project}[http://www.linuxnet.com/software.html]. If you go this route,
+you need to get at least the
+{pcsclite library}[http://pcsclite.alioth.debian.org/] and a driver.
++smartcard+ developers use the
+{CCID driver}[http://pcsclite.alioth.debian.org/], which works on most (new)
+readers.
 
 === Ubuntu
 
-Installing the following packages (and their dependencies) gets you going on Ubuntu (tested on 7.10):
-* buildessentials
+Installing the following packages (and their dependencies) gets you going on
+Ubuntu (tested on 7.10, 8.04, and 8.10):
+* build-essential
 * libccid
-* libpcsclite
-* libpcsclite-dev
+* libpcsclite-dev (depends on libpcsclite or libpcsclite1)
 * pcscd
 * pcsc-tools

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.3.2. Fixed documentation for ReaderStates class.
+
 v0.3.1. Fixed documentation for the new PcscException class.
 
 v0.3.0. Added PcscException class used to wrap PC/SC exceptions.

data/README

@@ -1,32 +1,37 @@
-+smartcard+ aims to become the standard support library for smart-card development on ruby.
-Right now, the project offers a PC/SC binding that is working on ruby 1.8, under
-Linux, OSX, and Windows. Future plans include a high level abstraction for the PC/SC binding 
-(plus any other bindings people need), and an interface for Java cards.
++smartcard+ aims to become the standard support library for smart-card
+development on ruby. Right now, the project offers a PC/SC binding that is
+working on ruby 1.8, under Linux, OSX, and Windows. Future plans include a high
+level abstraction for the PC/SC binding  (plus any other bindings people need),
+and an interface for Java cards.
 
 = Installation
 
 	gem install smartcard
 Windows:: Select the <tt>win32</tt> gem.
 OSX:: Install the Developer Tools to get +gcc+. Requires Tiger or Leopard.
-UNIX:: You need a PC/SC provider. See the {BUILD file}[link://files/BUILD.html] for details. The file also contains package lists for popular distributions.
+UNIX:: You need a PC/SC provider. See the {BUILD file}[link://files/BUILD.html]
+for details. The file also contains package lists for popular distributions.
 
 = Documentation
 
-The documentation you see was generated with RDoc. If you install the +smartcard+ gem, you should be
-able to use ri to see the documentation. If you're using the SVN version, you can <tt>rake doc</tt> to build
-the HTML documentation yourself.
+The documentation you see was generated with RDoc. If you install the
++smartcard+ gem, you should be able to use ri to see the documentation. If
+you're using the SVN version, you can <tt>rake doc</tt> to build the HTML
+documentation yourself.
 
 = License
 
-+smartcard+ is released under the MIT license. This means you're free to do whatever you want
-with it. However, it'd be nice to let the developers know if you plan to include this in a
-distribution (bragging rights are always good). The {LICENSE file}[link://files/LICENSE.html]
-has the license in legalese.
++smartcard+ is released under the MIT license. This means you're free to do
+whatever you want with it. However, it'd be nice to let the developers know if
+you plan to include this in a distribution (bragging rights are always good).
+The {LICENSE file}[link://files/LICENSE.html] has the license in legalese.
 
 = Acknowledgements
 
-+smartcard+ is developed by Victor Costan while working as a Research Assistant for MIT, under
-{Prof. Srini Devadas}[http://people.csail.mit.edu/devadas/], in the
-{Trusted Computing group}[http://projects.csail.mit.edu/tc/].
-The work is funded by a grant from {Quanta Computer Inc}[http://www.quanta.com.tw], under the
++smartcard+ is developed by Victor Costan while working as a Research Assistant
+for MIT, under {Prof. Srini Devadas}[http://people.csail.mit.edu/devadas/], in
+the {Trusted Computing group}[http://projects.csail.mit.edu/tc/].
+
+The work is funded by a grant from
+{Quanta Computer Inc}[http://www.quanta.com.tw], under the
 {T-Party Project}[http://projects.csail.mit.edu/tparty/].

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+gem 'echoe'
+require 'echoe'
+
+Echoe.new('smartcard') do |p|
+  p.project = 'smartcard' # rubyforge project
+  
+  p.author = 'Victor Costan'
+  p.email = 'victor@costan.us'
+  p.summary = 'Interface with ISO 7816 smart cards.'
+  p.url = 'http://www.costan.us/smartcard'
+  
+  p.need_tar_gz = !Platform.windows?
+  p.need_zip = !Platform.windows?
+  p.clean_pattern += ['ext/**/*.manifest', 'ext/**/*_autogen.h']
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^BUILD|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
+  
+  p.eval = proc do |p|
+    if Platform.windows?
+      p.files += ['lib/smartcard/pcsc.so']
+      p.platform = Gem::Platform::CURRENT
+
+      # take out the extension info from the gemspec
+      task :postcompile_hacks => [:compile] do
+        p.extensions.clear
+      end
+
+      task :package => [ :clean, :compile, :postcompile_hacks ]
+    end
+  end
+end
+
+if $0 == __FILE__
+  Rake.application = Rake::Application.new
+  Rake.application.run
+end

data/ext/smartcard_pcsc/extconf.rb

@@ -12,9 +12,10 @@ if RUBY_PLATFORM =~ /darwin/
     pcsc_defines.push 'RB_SMARTCARD_OSX_TIGER_HACK'
   end
 elsif RUBY_PLATFORM =~ /win/
-  
   have_library('winscard')
-  pcsc_defines << 'PCSC_SURROGATE_SCARD_IS_VALID_CONTEXT' unless have_library('winscard', 'SCardIsValidContext')
+  unless have_library('winscard', 'SCardIsValidContext')
+  	pcsc_defines << 'PCSC_SURROGATE_SCARD_IS_VALID_CONTEXT'
+  end 
 else
   # pcsclite is retarded and uses stuff like '#include <wintypes.h>'
   $CFLAGS += ' -I /usr/include/PCSC -I /usr/local/include/PCSC'
@@ -25,7 +26,9 @@ pcsc_headers = []
 ['wintypes.h', 'reader.h', 'winscard.h', 'pcsclite.h'].each do |header|
   ['', 'PCSC/', './pcsc_surrogate_'].each do |path_prefix|
     if have_header(path_prefix + header)
-      pcsc_headers.push((path_prefix[0,1] == '.') ? "\"#{path_prefix + header}\"" : "<#{path_prefix + header}>")
+      pcsc_headers.push((path_prefix[0,1] == '.') ?
+                        "\"#{path_prefix + header}\"" :
+                        "<#{path_prefix + header}>")
       break
     end
   end
@@ -34,9 +37,15 @@ end
 File.open('pcsc_autogen.h', 'w') do |f|
   pcsc_defines.each { |d| f.write "\#define #{d}\n" }
   pcsc_headers.each { |h| f.write "\#include #{h}\n" }
-end 
+end
+
+if have_macro('SCARDHANDLE', ['pcsc_autogen.h']) or
+    have_type('SCARDHANDLE', ['pcsc_autogen.h'])
+  create_makefile('smartcard/pcsc')
+else
+  STDERR.write "PC/SC libraries missing!\n"
+end
 
-create_makefile('smartcard/pcsc')
 
 def win32_hack(mf_name)
   # get the version of MSVC
@@ -50,7 +59,7 @@ def win32_hack(mf_name)
     return if msvc_ver == 12
   end
     
-  # evil, evil, evil -- hack the makefile to embed the manifest in the extension dll
+  # HACK: monkey-patch the makefile to embed a manifest in the extension dll
   make_contents = File.open(mf_name, 'r') { |f| f.read }
   make_rules = make_contents.split(/(\n|\r)(\n|\r)+/)
   new_make_rules = make_rules.map do |rule|

data/ext/smartcard_pcsc/pcsc_reader_states.c

@@ -38,7 +38,8 @@ static VALUE PCSC_ReaderStates_alloc(VALUE klass) {
  *      new(num_states) --> reader_states
  * 
  * Creates an array of +num_states+ reader state elements.
- * The states are unusable until they are assigned reader names by calling ReaderStates#set_reader_name_of.
+ * The states are unusable until they are assigned reader names by calling
+ * Smartcard::PCSC::ReaderStates#set_reader_name_of.
  */
 static VALUE PCSC_ReaderStates_initialize(VALUE self, VALUE rbNumStates) {
 	struct PCSCReaderStates *states;	
@@ -77,10 +78,12 @@ static int _validate_readerstates_args(VALUE rbReaderStates, VALUE rbIndex, stru
  * call-seq:
  *      current_state_of(index) --> current_state
  * 
- * The current state (_dwCurrentState_ in PC/SC) in the <tt>index</tt>th reader state element.
- * Smartcard::PCSC::Context#get_status_change blocks as long as the reader state equals this value. 
+ * The current state (_dwCurrentState_ in PC/SC) in the <tt>index</tt>th reader
+ * state element. Smartcard::PCSC::Context#get_status_change blocks as long as
+ * the reader state equals this value. 
  * 
- * The returned state is a bitfield; the bits are defined in the Smartcard::PCSC::STATE_ constants. 
+ * The returned state is a bitfield; the bits are defined in the
+ * Smartcard::PCSC::STATE_ constants. See Smartcard::PCSC::STATE_UNAWARE.
  * 
  * +index+:: the 0-based index of the reader state element to be queried
  */
@@ -98,10 +101,12 @@ static VALUE PCSC_ReaderStates_current_state_of(VALUE self, VALUE rbIndex) {
  * call-seq:
  *      event_state_of(index) --> event_state
  * 
- * The event state (_dwEventState_ in PC/SC) in the <tt>index</tt>th reader state element.
- * Smartcard::PCSC::Context#get_status_change stores the updated reader state in this value. 
+ * The event state (_dwEventState_ in PC/SC) in the <tt>index</tt>th reader
+ * state element. Smartcard::PCSC::Context#get_status_change stores the updated
+ * reader state in this value.
  * 
- * The returned state is a bitfield; the bits are defined in the Smartcard::PCSC::STATE_ constants. 
+ * The returned state is a bitfield; the bits are defined in the
+ * Smartcard::PCSC::STATE_ constants. See Smartcard::PCSC::STATE_UNAWARE.
  * 
  * +index+:: the 0-based index of the reader state element to be queried
  */

data/smartcard.gemspec

@@ -1,66 +1,32 @@
-
-# Gem::Specification for Smartcard-0.3.1
-# Originally generated by Echoe
+# -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{smartcard}
-  s.version = "0.3.1"
-
-  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.version = "0.3.2"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2008-05-01}
+  s.date = %q{2009-05-31}
   s.description = %q{Interface with ISO 7816 smart cards.}
   s.email = %q{victor@costan.us}
   s.extensions = ["ext/smartcard_pcsc/extconf.rb"]
   s.extra_rdoc_files = ["BUILD", "CHANGELOG", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard/pcsc_exception.rb", "lib/smartcard.rb", "LICENSE", "README"]
-  s.files = ["BUILD", "CHANGELOG", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard/pcsc_exception.rb", "lib/smartcard.rb", "LICENSE", "Manifest", "README", "test/test_containers.rb", "test/test_smoke.rb", "tests/ts_pcsc_ext.rb", "smartcard.gemspec"]
-  s.has_rdoc = true
+  s.files = ["BUILD", "CHANGELOG", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard/pcsc_exception.rb", "lib/smartcard.rb", "LICENSE", "Manifest", "README", "test/test_containers.rb", "test/test_smoke.rb", "tests/ts_pcsc_ext.rb", "smartcard.gemspec", "Rakefile"]
   s.homepage = %q{http://www.costan.us/smartcard}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Smartcard", "--main", "README"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{smartcard}
-  s.rubygems_version = %q{1.1.1}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{Interface with ISO 7816 smart cards.}
   s.test_files = ["test/test_containers.rb", "test/test_smoke.rb"]
-end
 
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
 
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'rubygems'
-# gem 'echoe'
-# require 'echoe'
-# 
-# Echoe.new('smartcard') do |p|
-#   p.project = 'smartcard' # rubyforge project
-#   
-#   p.author = 'Victor Costan'
-#   p.email = 'victor@costan.us'
-#   p.summary = 'Interface with ISO 7816 smart cards.'
-#   p.url = 'http://www.costan.us/smartcard'
-#   
-#   p.need_tar_gz = false
-#   p.clean_pattern += ['ext/**/*.manifest', 'ext/**/*_autogen.h']
-#   p.rdoc_pattern = /^(lib|bin|tasks|ext)|^BUILD|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
-#   
-#   p.eval = proc do |p|
-#     if Platform.windows?
-#       p.files += ['lib/smartcard/pcsc.so']
-#       p.platform = Gem::Platform::CURRENT
-# 
-#       # take out the extension info from the gemspec
-#       task :postcompile_hacks => [:compile] do
-#         p.extensions.clear
-#       end
-# 
-#       task :package => [ :clean, :compile, :postcompile_hacks ]
-#     end
-#   end
-# end
-# 
-# if $0 == __FILE__
-#   Rake.application = Rake::Application.new
-#   Rake.application.run
-# end
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smartcard
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-01 00:00:00 -04:00
+date: 2009-05-31 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -64,8 +64,11 @@ files:
 - test/test_smoke.rb
 - tests/ts_pcsc_ext.rb
 - smartcard.gemspec
+- Rakefile
 has_rdoc: true
 homepage: http://www.costan.us/smartcard
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -87,14 +90,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
 rubyforge_project: smartcard
-rubygems_version: 1.1.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Interface with ISO 7816 smart cards.
 test_files: 
 - test/test_containers.rb