nntp-client 0.0.5 → 0.0.6

data/.gitignore

@@ -1,17 +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
+*.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/.rspec

@@ -1,2 +1,2 @@
---format specdoc
---color
+--format specdoc
+--color

data/Gemfile

@@ -1,8 +1,8 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in nntp.gemspec
-gem 'rake'
-gem "rspec"
-gem "rspec-core"
-gem "rspec-expectations"
-gem "rspec-mocks"
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nntp.gemspec
+gem 'rake'
+gem "rspec"
+gem "rspec-core"
+gem "rspec-expectations"
+gem "rspec-mocks"

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2012 Michael Westbom
-
-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
+Copyright (c) 2012 Michael Westbom
+
+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/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"

data/lib/nntp/article.rb

@@ -0,0 +1,3 @@
+module NNTP
+  Article = Struct.new(:id, :subject, :group, :num)
+end

data/lib/nntp/connection.rb

@@ -7,7 +7,7 @@ module NNTP
   #  Most communication with an NNTP server happens in a back-and-forth
   #  style.
   #
-  #  The client sends a message to the server.  The server will respond with a status response, and sometimes with extra data. See {https://tools.ietf.org/html/rfc3977 RFC 3977} for more details.
+  #  The client sends a article to the server.  The server will respond with a status response, and sometimes with extra data. See {https://tools.ietf.org/html/rfc3977 RFC 3977} for more details.
   #
   #  This class handles this communication by providing two methods,
   #  one for use when additional data is expected, and one for when it is not.

data/lib/nntp/session.rb

@@ -1,17 +1,22 @@
 require "nntp/group"
-require 'nntp/message'
+require 'nntp/article'
 
 module NNTP
   # Most of the action happens here.  This class describes the
   # object the user interacts with the most.
   # It is constructed by NNTP::open, but you can build your own
   # if you like.
+
+  # @!attribute [r] article
+  #   The current article pointed to by the server or nil if unset.
+  #   @return [NNTP::Article, nil]
   class Session
-    attr_reader :connection, :group
+    attr_reader :connection, :group, :article
     # @option options [NNTP::Connection, NNTP::SSLConnection] :connection
     #   The connection object.
     def initialize(options)
       @group = nil
+      @article = nil
       @connection = options.fetch(:connection) do
         raise ArgumentError ":connection missing"
       end
@@ -51,18 +56,18 @@ module NNTP
       end
     end
 
-    # Fetch list of message numbers from a given group.
+    # Fetch list of article numbers from a given group.
     # @param group  The name of the group to list defaults to {#group #group.name}
     # @param range (nil) If given, specifies the range of messages to retrieve
-    # @return [Array<NNTP::Message>] The list of messages
-    #   (only the message numbers will be populated).
+    # @return [Array<NNTP::Article>] The list of messages
+    #   (only the article numbers will be populated).
     # @see https://tools.ietf.org/html/rfc3977#section-6.1.2
     def listgroup(*args)
       messages = []
       connection.query(:listgroup, *args) do |status, data|
         if status[:code] == 211
           data.each do |line|
-            message = Message.new
+            message = Article.new
             message.num = line.to_i
             messages << message
           end
@@ -71,8 +76,29 @@ module NNTP
       messages
     end
 
+    # Fetch ID and/or Number of an article.
+    #
+    # If an article number is passed, the current article is changed
+    # to the selected article.  If an ID is passed, the current article
+    # is NOT changed.
+    # @param id|num The article-id or article number to be selected.
+    # @return [NNTP::Article, nil] a Article struct or nil upon failure.
+    def stat(identifier = nil)
+      params = [:stat]
+      params += [identifier.to_s] unless identifier.nil?
+      connection.command(*params)
+      if status.code == 223
+        message = article_from_status(status.msg)
+        if identifier.to_i != 0
+          @article = message
+        end
+        message
+      else
+        nil
+      end
+    end
     # Fetch list of messages from current group.
-    # @return [Array<NNTP::Message>] The list of messages
+    # @return [Array<NNTP::Article>] The list of messages
     #   (The numbers AND the subjects will be populated).
     def subjects
       subjects = []
@@ -80,7 +106,7 @@ module NNTP
       connection.query(:xhdr, "Subject", range) do |status, data|
         if status[:code] == 221
           data.each do |line|
-            message = Message.new
+            message = Article.new
             message.num, message.subject = line.split(' ', 2)
             subjects << message
           end
@@ -108,6 +134,14 @@ module NNTP
       end
     end
 
+    def article_from_status(status_msg)
+      message = Article.new
+      num, id = status_msg.split(' ', 2)
+      message.num = num.to_i unless num.to_i.zero?
+      message.id = id
+      message
+    end
+
     def check_initial_status
       raise "#{status}" if [400, 502].include? connection.get_status.code
     end

data/lib/nntp/status.rb

@@ -1,7 +1,7 @@
-module NNTP
-  Status = Struct.new(:code, :msg) do
-    def to_s
-      "#{self[:code]} #{self[:msg]}"
-    end
-  end
+module NNTP
+  Status = Struct.new(:code, :msg) do
+    def to_s
+      "#{self[:code]} #{self[:msg]}"
+    end
+  end
 end

data/lib/nntp/version.rb

@@ -1,3 +1,3 @@
 module NNTP
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/session_spec.rb

@@ -100,4 +100,21 @@ describe NNTP::Session do
       message_subjects(nntp.subjects).should eq ['Foo bar', 'Baz bang']
     end
   end
+  describe "#stat" do
+    let(:article) do
+      msg = NNTP::Article.new
+      msg.num = 1
+      msg.id = "<foo@bar.baz>"
+      msg
+    end
+
+    it "can set the current article using an article number" do
+      sock.should_receive(:print).with("STAT 1\r\n")
+      sock.should_receive(:gets).and_return("223 1 <foo@bar.baz>\r\n")
+      nntp.stub(:group) {NNTP::Group.new("alt.bin.foo", 1, 2, 2)}
+      nntp.stat(1)
+      nntp.status.should eq NNTP::Status.new(223, "1 <foo@bar.baz>")
+      nntp.article.should eq article
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nntp-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -40,12 +40,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/NNTPClient.rb
-- lib/article.rb
 - lib/nntp.rb
+- lib/nntp/article.rb
 - lib/nntp/connection.rb
 - lib/nntp/group.rb
-- lib/nntp/message.rb
 - lib/nntp/session.rb
 - lib/nntp/ssl_connection.rb
 - lib/nntp/status.rb
@@ -87,4 +85,3 @@ test_files:
 - spec/nntp_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/NNTPClient.rb

@@ -1,120 +0,0 @@
-require 'socket'
-require_relative 'group'
-require_relative 'article'
-require "NNTPClient/version"
-
-class NNTPClient
-  attr_reader :socket, :status, :current_group
-
-  def initialize(options = {})
-    @socket = open_socket(options)
-    init_attributes
-  end
-
-  def groups
-    @groups ||= list_groups
-  end
-
-  def group(group)
-    send_message "GROUP #{group}"
-    self.status = get_status
-    if status[:code] == 211
-      self.current_group = create_group(status)
-    end
-  end
-
-  def articles
-    @articles ||= fetch_articles
-  end
-
-  def auth(options = {})
-    send_message "AUTHINFO USER #{options[:user]}"
-    self.status = get_status
-    send_message "AUTHINFO PASS #{options[:pass]}"
-    self.status = get_status
-    if status[:code] == 281
-      true
-    else
-      false
-    end
-  end
-  private
-  def fetch_articles
-    send_message "XHDR Subject #{current_group.first}-"
-    self.status = get_status
-    return nil unless status[:code] == 221
-    get_data_block.map do |line|
-      article_id, article_subject = line.split(' ', 2)
-      NNTP::Article.new(article_id, article_subject)
-    end
-  end
-
-  def init_attributes
-    @current_group = nil
-    @status = nil
-    @groups = nil
-    @articles = nil
-  end
-
-  def create_group(status)
-    params = status[:params]
-    # TODO: This is ugly
-    NNTP::Group.new(*params[1..-1])
-  end
-
-  def open_socket(options)
-    options.fetch(:socket) {
-      url = options.fetch(:url) { raise ArgumentError, ':url is required' }
-      port = options.fetch(:port, 119)
-      socket_factory = options.fetch(:socket_factory) { TCPSocket }
-      socket_factory.new(url, port)
-    }
-  end
-
-  def list_groups
-    send_message "LIST"
-    status = get_status
-    return nil unless status[:code] == 215
-
-    get_data_block
-  end
-
-  def groups=(list=[])
-    @groups = list
-  end
-
-  def status=(status)
-    @status = status
-  end
-
-  def current_group=(group)
-    @current_group = group
-  end
-
-  def get_status
-    line = get_line
-    {
-      :code => line[0..2].to_i,
-      :message => line[3..-1].lstrip,
-      :params => line.split
-    }
-  end
-
-  def get_data_block
-    lines = []
-    current_line = get_line
-    until current_line == '.'
-      lines << current_line
-      current_line = get_line
-    end
-    lines
-  end
-
-  def get_line
-    socket.gets().chomp
-  end
-
-  def send_message(msg)
-    socket.print "#{msg}\r\n"
-  end
-end

data/lib/article.rb

@@ -1,7 +0,0 @@
-module NNTP
-  Article = Struct.new(:number, :subject, :article_id) do
-    def to_s
-      subject
-    end
-  end
-end

data/lib/nntp/message.rb

@@ -1,3 +0,0 @@
-module NNTP
-  Message = Struct.new(:id, :subject, :group, :num)
-end