diaspora_federation 0.0.1 → 0.0.2

data/lib/diaspora_federation/web_finger/host_meta.rb

@@ -1,7 +1,6 @@
 
 module DiasporaFederation
   module WebFinger
-    ##
     # Generates and parses Host Meta documents.
     #
     # This is a minimal implementation of the standard, only to the degree of what
@@ -23,7 +22,6 @@ module DiasporaFederation
       # URL fragment to append to the base URL
       WEBFINGER_SUFFIX = "webfinger?q={uri}"
 
-      ##
       # Returns the WebFinger URL that was used to build this instance (either from
       # xml or by giving a base URL).
       # @return [String] WebFinger template URL
@@ -31,7 +29,6 @@ module DiasporaFederation
         @webfinger_url
       end
 
-      ##
       # Produces the XML string for the Host Meta instance with a +Link+ element
       # containing the +webfinger_url+.
       # @return [String] XML string
@@ -43,7 +40,6 @@ module DiasporaFederation
         doc.to_xml
       end
 
-      ##
       # Builds a new HostMeta instance and constructs the WebFinger URL from the
       # given base URL by appending HostMeta::WEBFINGER_SUFFIX.
       # @return [HostMeta]
@@ -60,7 +56,6 @@ module DiasporaFederation
         hm
       end
 
-      ##
       # Reads the given Host Meta XML document string and populates the
       # +webfinger_url+.
       # @param [String] hostmeta_xml Host Meta XML string
@@ -77,7 +72,6 @@ module DiasporaFederation
         hm
       end
 
-      ##
       # Applies some basic sanity-checking to the given URL
       # @param [String] url validation subject
       # @return [Boolean] validation result
@@ -86,7 +80,6 @@ module DiasporaFederation
       end
       private_class_method :webfinger_url_valid?
 
-      ##
       # Gets the webfinger url from an XRD data structure
       # @param [Hash] data extracted data
       # @return [String] webfinger url

data/lib/diaspora_federation/web_finger/web_finger.rb

@@ -1,6 +1,5 @@
 module DiasporaFederation
   module WebFinger
-    ##
     # The WebFinger document used for Diaspora* user discovery is based on an older
     # draft of the specification you can find in the wiki of the "webfinger" project
     # on {http://code.google.com/p/webfinger/wiki/WebFingerProtocol Google Code}
@@ -9,18 +8,18 @@ module DiasporaFederation
     # In the meantime an actual RFC draft has been in development, which should
     # serve as a base for all future changes of this implementation.
     #
-    # @example Creating a WebFinger document from account data
-    #   wf = WebFinger.from_person({
+    # @example Creating a WebFinger document from a person hash
+    #   wf = WebFinger.new(
     #     acct_uri:    "acct:user@server.example",
     #     alias_url:   "https://server.example/people/0123456789abcdef",
-    #     hcard_url:   "https://server.example/hcard/users/0123456789abcdef",
+    #     hcard_url:   "https://server.example/hcard/users/user",
     #     seed_url:    "https://server.example/",
     #     profile_url: "https://server.example/u/user",
     #     atom_url:    "https://server.example/public/user.atom",
     #     salmon_url:  "https://server.example/receive/users/0123456789abcdef",
     #     guid:        "0123456789abcdef",
-    #     pubkey:      "-----BEGIN PUBLIC KEY-----\nABCDEF==\n-----END PUBLIC KEY-----"
-    #   })
+    #     public_key:  "-----BEGIN PUBLIC KEY-----\nABCDEF==\n-----END PUBLIC KEY-----"
+    #   )
     #   xml_string = wf.to_xml
     #
     # @example Creating a WebFinger instance from an xml document
@@ -34,62 +33,72 @@ module DiasporaFederation
     # @see http://code.google.com/p/webfinger/wiki/CommonLinkRelations
     # @see http://www.iana.org/assignments/link-relations/link-relations.xhtml
     #   official list of IANA link relations
-    class WebFinger
-      private_class_method :new
-
-      # The Subject element should contain the webfinger address that was asked
-      # for. If it does not, then this webfinger profile MUST be ignored.
-      # @return [String]
-      attr_reader :acct_uri
-
-      # @return [String] link to the users profile
-      attr_reader :alias_url, :profile_url
-
-      # @return [String] link to the +hCard+
-      attr_reader :hcard_url
-
-      # @return [String] link to the pod
-      attr_reader :seed_url
-
-      # This atom feed is an Activity Stream of the user's public posts. Diaspora
-      # pods SHOULD publish an Activity Stream of public posts, but there is
-      # currently no requirement to be able to read Activity Streams.
-      # @see http://activitystrea.ms/ Activity Streams specification
+    class WebFinger < Entity
+      # @!attribute [r] acct_uri
+      #   The Subject element should contain the webfinger address that was asked
+      #   for. If it does not, then this webfinger profile MUST be ignored.
+      #   @return [String]
+      property :acct_uri
+
+      # @!attribute [r] alias_url
+      #   @return [String] link to the users profile
+      property :alias_url
+
+      # @!attribute [r] hcard_url
+      #   @return [String] link to the +hCard+
+      property :hcard_url
+
+      # @!attribute [r] seed_url
+      #   @return [String] link to the pod
+      property :seed_url
+
+      # @!attribute [r] profile_url
+      #   @return [String] link to the users profile
+      property :profile_url
+
+      # @!attribute [r] atom_url
+      #   This atom feed is an Activity Stream of the user's public posts. Diaspora
+      #   pods SHOULD publish an Activity Stream of public posts, but there is
+      #   currently no requirement to be able to read Activity Streams.
+      #   @see http://activitystrea.ms/ Activity Streams specification
       #
-      # Note that this feed MAY also be made available through the PubSubHubbub
-      # mechanism by supplying a <link rel="hub"> in the atom feed itself.
-      # @return [String] atom feed url
-      attr_reader :atom_url
-
-      # @return [String] salmon endpoint url
-      # @see http://salmon-protocol.googlecode.com/svn/trunk/draft-panzer-salmon-00.html#SMLR
-      #   Panzer draft for Salmon, paragraph 3.3
-      attr_reader :salmon_url
-
-      # @deprecated Either convert these to +Property+ elements or move to the
-      #   +hCard+, which actually has fields for an +UID+ defined in the +vCard+
-      #   specification (will affect older Diaspora* installations).
+      #   Note that this feed MAY also be made available through the PubSubHubbub
+      #   mechanism by supplying a <link rel="hub"> in the atom feed itself.
+      #   @return [String] atom feed url
+      property :atom_url
+
+      # @!attribute [r] salmon_url
+      #   @return [String] salmon endpoint url
+      #   @see http://salmon-protocol.googlecode.com/svn/trunk/draft-panzer-salmon-00.html#SMLR
+      #     Panzer draft for Salmon, paragraph 3.3
+      property :salmon_url
+
+      # @!attribute [r] guid
+      #   @deprecated Either convert these to +Property+ elements or move to the
+      #     +hCard+, which actually has fields for an +UID+ defined in the +vCard+
+      #     specification (will affect older Diaspora* installations).
       #
-      # @see HCard#guid
+      #   @see HCard#guid
       #
-      # This is just the guid. When a user creates an account on a pod, the pod
-      # MUST assign them a guid - a random hexadecimal string of at least 8
-      # hexadecimal digits.
-      # @return [String] guid
-      attr_reader :guid
-
-      # @deprecated Either convert these to +Property+ elements or move to the
-      #   +hCard+, which actually has fields for an +KEY+ defined in the +vCard+
-      #   specification (will affect older Diaspora* installations).
+      #   This is just the guid. When a user creates an account on a pod, the pod
+      #   MUST assign them a guid - a random hexadecimal string of at least 8
+      #   hexadecimal digits.
+      #   @return [String] guid
+      property :guid
+
+      # @!attribute [r] public_key
+      #   @deprecated Either convert these to +Property+ elements or move to the
+      #     +hCard+, which actually has fields for an +KEY+ defined in the +vCard+
+      #     specification (will affect older Diaspora* installations).
       #
-      # @see HCard#pubkey
+      #   @see HCard#pubkey
       #
-      # When a user is created on the pod, the pod MUST generate a pgp keypair
-      # for them. This key is used for signing messages. The format is a
-      # DER-encoded PKCS#1 key beginning with the text
-      # "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".
-      # @return [String] public key
-      attr_reader :pubkey
+      #   When a user is created on the pod, the pod MUST generate a pgp keypair
+      #   for them. This key is used for signing messages. The format is a
+      #   DER-encoded PKCS#1 key beginning with the text
+      #   "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".
+      #   @return [String] public key
+      property :public_key
 
       # +hcard_url+ link relation
       REL_HCARD = "http://microformats.org/profile/hcard"
@@ -131,31 +140,6 @@ module DiasporaFederation
         doc.to_xml
       end
 
-      # Create a WebFinger instance from the given person data Hash.
-      # @param [Hash] data account data
-      # @return [WebFinger] WebFinger instance
-      # @raise [InvalidData] if the given data Hash is invalid or incomplete
-      def self.from_person(data)
-        raise InvalidData, "person data incomplete" unless account_data_complete?(data)
-
-        wf = allocate
-        wf.instance_eval {
-          @acct_uri    = data[:acct_uri]
-          @alias_url   = data[:alias_url]
-          @hcard_url   = data[:hcard_url]
-          @seed_url    = data[:seed_url]
-          @profile_url = data[:profile_url]
-          @atom_url    = data[:atom_url]
-          @salmon_url  = data[:salmon_url]
-
-          # TODO: remove me!  #########
-          @guid        = data[:guid]
-          @pubkey      = data[:pubkey]
-          #############################
-        }
-        wf
-      end
-
       # Create a WebFinger instance from the given XML string.
       # @param [String] webfinger_xml WebFinger XML string
       # @return [WebFinger] WebFinger instance
@@ -163,40 +147,25 @@ module DiasporaFederation
       def self.from_xml(webfinger_xml)
         data = parse_xml_and_validate(webfinger_xml)
 
-        hcard_url, seed_url, guid, profile_url, atom_url, salmon_url, pubkey = parse_links(data)
+        hcard_url, seed_url, guid, profile_url, atom_url, salmon_url, public_key = parse_links(data)
 
-        wf = allocate
-        wf.instance_eval {
-          @acct_uri    = data[:subject]
-          @alias_url   = data[:aliases].first
-          @hcard_url   = hcard_url
-          @seed_url    = seed_url
-          @profile_url = profile_url
-          @atom_url    = atom_url
-          @salmon_url  = salmon_url
+        new(
+          acct_uri:    data[:subject],
+          alias_url:   data[:aliases].first,
+          hcard_url:   hcard_url,
+          seed_url:    seed_url,
+          profile_url: profile_url,
+          atom_url:    atom_url,
+          salmon_url:  salmon_url,
 
           # TODO: remove me!  ##########
-          @guid        = guid
-          @pubkey      = Base64.strict_decode64(pubkey)
-          ##############################
-        }
-        wf
+          guid:        guid,
+          public_key:  Base64.strict_decode64(public_key)
+        )
       end
 
       private
 
-      # Checks the given account data Hash for correct type and completeness.
-      # @param [Hash] data account data
-      # @return [Boolean] validation result
-      def self.account_data_complete?(data)
-        data.instance_of?(Hash) &&
-          %i(
-            acct_uri alias_url hcard_url seed_url
-            guid profile_url atom_url salmon_url pubkey
-          ).all? {|k| data.key? k }
-      end
-      private_class_method :account_data_complete?
-
       # Parses the XML string to a Hash and does some rudimentary checking on
       # the data Hash.
       # @param [String] webfinger_xml WebFinger XML string
@@ -236,7 +205,7 @@ module DiasporaFederation
         # TODO: remove me!  ##############
         doc.links << {rel:  REL_PUBKEY,
                       type: "RSA",
-                      href: Base64.strict_encode64(@pubkey)}
+                      href: Base64.strict_encode64(@public_key)}
         ##################################
       end
 

data/lib/diaspora_federation/web_finger/xrd_document.rb

@@ -1,6 +1,5 @@
 module DiasporaFederation
   module WebFinger
-    ##
     # This class implements basic handling of XRD documents as far as it is
     # necessary in the context of the protocols used with Diaspora* federation.
     #
@@ -65,7 +64,6 @@ module DiasporaFederation
         @properties = {}
       end
 
-      ##
       # Generates an XML document from the current instance and returns it as string
       # @return [String] XML document
       def to_xml
@@ -83,7 +81,6 @@ module DiasporaFederation
         builder.to_xml
       end
 
-      ##
       # Parse the XRD document from the given string and create a hash containing
       # the extracted data.
       #

data/lib/tasks/build.rake

@@ -0,0 +1,17 @@
+desc "Build gem into the pkg directory"
+task build: :test do
+  FileUtils.rm_rf("pkg")
+  Dir["*.gemspec"].each do |gemspec|
+    system "gem build #{gemspec}"
+  end
+  FileUtils.mkdir_p("pkg")
+  FileUtils.mv(Dir["*.gem"], "pkg")
+end
+
+desc "Tags version, pushes to remote, and pushes gem"
+task release: :build do
+  sh "git tag v#{DiasporaFederation::VERSION}"
+  sh "git push origin master"
+  sh "git push origin v#{DiasporaFederation::VERSION}"
+  sh "ls pkg/*.gem | xargs -n 1 gem push"
+end

metadata

@@ -1,45 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Benjamin Neff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.2.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.6.2
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.6.2
-description: A rails engine that adds the diaspora* federation protocol to a rails
-  app
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+description: This gem provides the functionality for de-/serialization and de-/encryption
+  of Entities in the protocols used for communication among the various installations
+  of Diaspora*
 email:
 - benjamin@coding4.coffee
 executables: []
@@ -48,15 +41,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- Rakefile
-- app/controllers/diaspora_federation/application_controller.rb
-- app/controllers/diaspora_federation/h_card_controller.rb
-- app/controllers/diaspora_federation/receive_controller.rb
-- app/controllers/diaspora_federation/webfinger_controller.rb
-- config/routes.rb
 - lib/diaspora_federation.rb
-- lib/diaspora_federation/engine.rb
+- lib/diaspora_federation/callbacks.rb
+- lib/diaspora_federation/entity.rb
 - lib/diaspora_federation/logging.rb
+- lib/diaspora_federation/properties_dsl.rb
 - lib/diaspora_federation/version.rb
 - lib/diaspora_federation/web_finger.rb
 - lib/diaspora_federation/web_finger/exceptions.rb
@@ -64,6 +53,7 @@ files:
 - lib/diaspora_federation/web_finger/host_meta.rb
 - lib/diaspora_federation/web_finger/web_finger.rb
 - lib/diaspora_federation/web_finger/xrd_document.rb
+- lib/tasks/build.rake
 - lib/tasks/diaspora_federation_tasks.rake
 - lib/tasks/tests.rake
 homepage: https://github.com/SuperTux88/diaspora_federation
@@ -76,9 +66,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -89,6 +79,6 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: diaspora* federation rails engine
+summary: diaspora* federation library
 test_files: []
 has_rdoc: 

data/Rakefile

@@ -1,26 +0,0 @@
-begin
-  require "bundler/setup"
-rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
-end
-
-require "rdoc/task"
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "DiasporaFederation"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load "rails/tasks/engine.rake"
-
-load "rails/tasks/statistics.rake"
-
-Bundler::GemHelper.install_tasks
-
-Rails.application.load_tasks
-
-task test: %w(spec:prepare spec)
-task default: :test