vayacondios-server 0.1.7 → 0.1.10

data/README.md

@@ -1,7 +1,11 @@
-# WARNING! THIS DOCUMENT IS OUTDATED AND MAY NOT REFLECT ACTUAL CODE! GO READ THE SPECS FOR BEHAVIORS!
-
 # Vaya con Dios
 
+## Warning
+
+Some of the documentation on this page is for legacy versions of
+Vayacondios. Until this document is updated, please see the specs for
+the Ruby code or compile the javadocs for the Java API.
+
 > "Data goes in. The right thing happens."
 
 Simple enough to use in a shell script, performant enough to use everywhere.

data/examples/java/ItemSetTest.java

@@ -0,0 +1,76 @@
+import com.infochimps.vayacondios.Organization;
+import com.infochimps.vayacondios.VayacondiosClient;
+import com.infochimps.vayacondios.ItemSets;
+import static com.infochimps.vayacondios.ItemSets.Item;
+import static com.infochimps.vayacondios.ItemSets.ItemSet;
+
+import java.io.*;
+import java.util.*;
+
+public class ItemSetTest {
+  private static final int VCD_PORT = 8000;
+
+  public static void main(String argv[]) throws IOException {
+    // Instantiate a new Vayacondios client.
+    VayacondiosClient client = new VayacondiosClient("localhost", VCD_PORT);
+
+    // Organizations can allow for testing and multiple environments
+    // (staging, development).
+    Organization org = client.organization("test");
+
+    // At the moment, only the itemsets protocol is supported via a
+    // Java API.
+    ItemSets isets = org.itemsets();
+
+    List<Item> foobar = Arrays.asList(new Item("foo"), new Item("bar"));
+
+    // All of the following are equivalent ways to clobber the itemset
+    // at topic my_topic and id my_id, replacing it with the items
+    // "foo" and "bar." The first and second exist to avoid
+    // instantiating new objects repeatedly when a code path must
+    // access many different topics and ids.
+    isets                                   .create("my_topic", "my_id", foobar);
+    isets.topic("my_topic")                 .create(            "my_id", foobar);
+    isets.topic("my_topic").itemSet("my_id").create(                     foobar);
+
+    List<Item> fetched;
+
+    // Similarly, these are all equivalent ways to fetch items.
+    fetched = isets                                   .fetch("my_topic", "my_id");
+    fetched = isets.topic("my_topic")                 .fetch(            "my_id");
+    fetched = isets.topic("my_topic").itemSet("my_id").fetch(                   );
+
+    ItemSet iset = isets.topic("my_topic").itemSet("my_id");
+
+    // foo and bar will be printed, along with their types: STRING
+    System.out.println("fetched items: " + fetched);
+
+    List<Item> bazqux = Arrays.asList(new Item("baz"), new Item("qux"));
+
+    // Updating an itemset with a list of items ensures the presence
+    // in the itemset of all of the items in the specified list.
+    isets                                   .update("my_topic", "my_id", bazqux);
+    isets.topic("my_topic")                 .update(            "my_id", bazqux);
+    isets.topic("my_topic").itemSet("my_id").update(                     bazqux);
+
+    // foo, bar, baz, and qux will all be printed.
+    System.out.println("after update: " + iset.fetch());
+
+    List<Item> barbaz = Arrays.asList(new Item("bar"), new Item("baz"));
+
+    // Updating an itemset with a list of items ensures the presence
+    // in the itemset of all of the items in the specified list.
+    isets                                   .remove("my_topic", "my_id", barbaz);
+    isets.topic("my_topic")                 .remove(            "my_id", barbaz);
+    isets.topic("my_topic").itemSet("my_id").remove(                     barbaz);
+
+    // foo and qux will now be printed
+    System.out.println("after removing: " + iset.fetch());
+
+    // Create an empty itemset to effectively delete it.
+    iset.create(Collections.EMPTY_LIST);
+
+    // foo and qux will now be printed
+    System.out.println("after deletion: " + iset.fetch());
+  }
+}

data/lib/vayacondios/client/itemset.rb

@@ -1,3 +1,4 @@
+require 'gorillib/logger/log'
 require 'net/http'
 require 'multi_json'
 
@@ -29,7 +30,6 @@ class Vayacondios
         execute_request(_req(:remove, ary, organization, topic, id))
       end
 
-
       private
 
       def execute_request req
@@ -68,5 +68,41 @@ class Vayacondios
         end
       end
     end
+
+    # Subclasses should implement the remove_items(arr) and
+    # add_items(arr) methods, both of which will be called with arrays
+    # when the items in an itemset change. The run method polls the
+    # provided itemset at a specified interval and calls these methods
+    # appropriately.
+    class ItemSetListener
+      POLL_WAIT_SEC=2
+
+      def initialize itemset, poll_wait_sec = POLL_WAIT_SEC
+        @itemset = itemset
+        @items = []
+        @poll_wait_sec = poll_wait_sec
+      end
+
+      def setup() end
+      def teardown() end
+
+      def run
+        setup
+        loop do
+          new_items = @itemset.fetch || []
+
+          Log.debug "currently configured: #{@items.inspect}"
+          Log.debug "new items: #{new_items.inspect}"
+
+          add_items(new_items - @items)
+          remove_items(@items - new_items)
+
+          @items = new_items
+
+          sleep @poll_wait_sec
+        end
+        teardown
+      end
+    end
   end
 end

data/lib/vayacondios/version.rb

@@ -1,3 +1,3 @@
 class Vayacondios
-  VERSION = '0.1.7'
+  VERSION = '0.1.10'
 end

data/pom.xml

@@ -4,7 +4,7 @@
   <groupId>com.infochimps</groupId>
   <artifactId>vayacondios</artifactId>
   <packaging>jar</packaging>
-  <version>1.0.0-SNAPSHOT</version>
+  <version>1.0.1-SNAPSHOT</version>
   <name>java-common</name>
   <url>http://maven.apache.org</url>
 
@@ -14,6 +14,19 @@
     <version>1.0.0-SNAPSHOT</version>
   </parent>
 
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.9</version>
+        <configuration>
+	  <show>public</show>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
+
   <build>
     <plugins>
       <plugin>

data/src/main/java/ItemSetTest.java

@@ -0,0 +1,76 @@
+import com.infochimps.vayacondios.Organization;
+import com.infochimps.vayacondios.VayacondiosClient;
+import com.infochimps.vayacondios.ItemSets;
+import static com.infochimps.vayacondios.ItemSets.Item;
+import static com.infochimps.vayacondios.ItemSets.ItemSet;
+
+import java.io.*;
+import java.util.*;
+
+public class ItemSetTest {
+  private static final int VCD_PORT = 8000;
+
+  public static void main(String argv[]) throws IOException {
+    // Instantiate a new Vayacondios client.
+    VayacondiosClient client = new VayacondiosClient("localhost", VCD_PORT);
+
+    // Organizations can allow for testing and multiple environments
+    // (staging, development).
+    Organization org = client.organization("test");
+
+    // At the moment, only the itemsets protocol is supported via a
+    // Java API.
+    ItemSets isets = org.itemsets();
+
+    List<Item> foobar = Arrays.asList(new Item("foo"), new Item("bar"));
+
+    // All of the following are equivalent ways to clobber the itemset
+    // at topic my_topic and id my_id, replacing it with the items
+    // "foo" and "bar." The first and second exist to avoid
+    // instantiating new objects repeatedly when a code path must
+    // access many different topics and ids.
+    isets                                   .create("my_topic", "my_id", foobar);
+    isets.topic("my_topic")                 .create(            "my_id", foobar);
+    isets.topic("my_topic").itemSet("my_id").create(                     foobar);
+
+    List<Item> fetched;
+
+    // Similarly, these are all equivalent ways to fetch items.
+    fetched = isets                                   .fetch("my_topic", "my_id");
+    fetched = isets.topic("my_topic")                 .fetch(            "my_id");
+    fetched = isets.topic("my_topic").itemSet("my_id").fetch(                   );
+
+    ItemSet iset = isets.topic("my_topic").itemSet("my_id");
+
+    // foo and bar will be printed, along with their types: STRING
+    System.out.println("fetched items: " + fetched);
+
+    List<Item> bazqux = Arrays.asList(new Item("baz"), new Item("qux"));
+
+    // Updating an itemset with a list of items ensures the presence
+    // in the itemset of all of the items in the specified list.
+    isets                                   .update("my_topic", "my_id", bazqux);
+    isets.topic("my_topic")                 .update(            "my_id", bazqux);
+    isets.topic("my_topic").itemSet("my_id").update(                     bazqux);
+
+    // foo, bar, baz, and qux will all be printed.
+    System.out.println("after update: " + iset.fetch());
+
+    List<Item> barbaz = Arrays.asList(new Item("bar"), new Item("baz"));
+
+    // Updating an itemset with a list of items ensures the presence
+    // in the itemset of all of the items in the specified list.
+    isets                                   .remove("my_topic", "my_id", barbaz);
+    isets.topic("my_topic")                 .remove(            "my_id", barbaz);
+    isets.topic("my_topic").itemSet("my_id").remove(                     barbaz);
+
+    // foo and qux will now be printed
+    System.out.println("after removing: " + iset.fetch());
+
+    // Create an empty itemset to effectively delete it.
+    iset.create(Collections.EMPTY_LIST);
+
+    // foo and qux will now be printed
+    System.out.println("after deletion: " + iset.fetch());
+  }
+}

data/src/main/java/com/infochimps/util/HttpHelper.java

@@ -35,19 +35,30 @@ public class HttpHelper {
   public static BufferedReader open(Logger log,
 				    String urlString,
 				    Charset inputCharset) throws IOException {
-    HttpURLConnection con = getConnection(urlString, log);
-    return getReader(con, log, inputCharset);
+    return getReader(openStream(log, urlString), inputCharset);
   }
 
   public static BufferedReader open(Logger log,
 				    String urlString,
 				    HashMap<String,String> extraHeaders,
 				    Charset inputCharset) throws IOException {
+    return getReader(openStream(log, urlString, extraHeaders), inputCharset);
+
+  }
+
+  public static InputStream openStream(Logger log,
+				       String urlString) throws IOException {
+    HttpURLConnection con = getConnection(urlString, log);
+    return getStream(con, log);
+  }
 
+  public static InputStream openStream(Logger log,
+				       String urlString,
+				       HashMap<String,String> extraHeaders) throws IOException {
     HttpURLConnection con = getConnection(urlString, log);
     for (Entry<String,String> header : extraHeaders.entrySet())
       con.setRequestProperty(header.getKey(), header.getValue());
-    return getReader(con, log, inputCharset);
+    return getStream(con, log);
   }
 
   private static HttpURLConnection getConnection(String urlString, Logger log) throws IOException {
@@ -71,9 +82,8 @@ public class HttpHelper {
     return con;
   }
 
-  private static BufferedReader getReader(HttpURLConnection con,
-					  Logger log,
-					  Charset inputCharset) throws IOException {
+  private static InputStream getStream(HttpURLConnection con,
+				       Logger log) throws IOException {
     InputStream in = null;
 
     try { in = con.getInputStream(); }
@@ -95,18 +105,17 @@ public class HttpHelper {
       throw e;
     }
 
+    log.debug("successfully opened connection to " + con.getURL().toString());
     String encoding = con.getContentEncoding();
     log.debug("Got HTTP stream with content encoding type '" + encoding + "'");
 
-    if (encoding != null && encoding.equals("gzip")) in = new GZIPInputStream(in);
+    return (encoding != null && encoding.equals("gzip")) ? new GZIPInputStream(in) : in;
+  }
 
+  private static BufferedReader getReader(InputStream in, Charset inputCharset) {
     InputStreamReader istream_reader = new InputStreamReader(in, inputCharset);
     BufferedReader reader = new BufferedReader(istream_reader);
 
-    log.debug("successfully opened connection to {} with character encoding {}",
-	      con.getURL().toString(),
-	      istream_reader.getEncoding());
-
     return reader;
   }
 }

data/src/main/java/com/infochimps/vayacondios/ItemSets.java

@@ -113,50 +113,50 @@ public class ItemSets extends Organization {
    * Creates a new itemset with the specified topic and id, clobbering
    * any existing itemset with the same topic and id.
    * 
-   * @param items items whose existence should be ensured in the set.
    * @param topic A Vayacondios topic has many ids. See vayacondios
    *              documentation for further details.
    * @param id A Vayacondios id, together with the server,
    *           organization, and topic, specifies a unique
    *           itemset.
+   * @param items items whose existence should be ensured in the set.
    */
-  public void create(List<Item> items,
-		     String topic,
-		     String id) throws IOException {
-    mutate("PUT", items, topic, id);
+  public void create(String topic,
+		     String id,
+		     List<Item> items) throws IOException {
+    mutate("PUT", topic, id, items);
   }
 
   /**
    * Ensures the absence of the specified items from the specified itemset.q
    * 
-   * @param items items whose absence should be ensured in the set.
    * @param topic A Vayacondios topic has many ids. See vayacondios
    *              documentation for further details.
    * @param id A Vayacondios id, together with the server,
    *           organization, and topic, specifies a unique
    *           itemset.
+   * @param items items whose absence should be ensured in the set.
    */
-  public void remove(List<Item> items,
-		     String topic,
-		     String id) throws IOException {
-    mutate("DELETE", items, topic, id);
+  public void remove(String topic,
+		     String id,
+		     List<Item> items) throws IOException {
+    mutate("DELETE", topic, id, items);
   }
 
   /**
    * Updates the current value of an itemset, ensuring the existence
    * of the specified items.
    * 
-   * @param items items whose existence should be ensured in the set.
    * @param topic A Vayacondios topic has many ids. See vayacondios
    *              documentation for further details.
    * @param id A Vayacondios id, together with the server,
    *           organization, and topic, specifies a unique
    *           itemset.
+   * @param items items whose existence should be ensured in the set.
    */
-  public void update(List<Item> items,
-		     String topic,
-		     String id) throws IOException {
-    mutate("PATCH", items, topic, id);
+  public void update(String topic,
+		     String id,
+		     List<Item> items) throws IOException {
+    mutate("PATCH", topic, id, items);
   }
 
   //----------------------------------------------------------------------------
@@ -170,9 +170,9 @@ public class ItemSets extends Organization {
   //----------------------------------------------------------------------------
 
   protected void mutate(String method,
-			List<Item> items,
 			String topic,
-			String id) throws IOException {
+			String id,
+			List<Item> items) throws IOException {
 
     // serialize the items
     HashMap content = new HashMap();
@@ -273,7 +273,7 @@ public class ItemSets extends Organization {
     //--------------------------------------------------------------------------
 
     /**
-     * @see ItemSets::fetch
+     * @see ItemSets#fetch
      */
     public List<Item> fetch(String id) throws IOException {
       return fetch(getTopic(), id);
@@ -282,22 +282,22 @@ public class ItemSets extends Organization {
     /**
      * @see ItemSets::create
      */
-    public void create(List<Item> items, String id) throws IOException {
-      create(items, getTopic(), id);
+    public void create(String id, List<Item> items) throws IOException {
+      create(getTopic(), id, items);
     }
 
     /**
-     * @see ItemSets::remove
+     * @see ItemSets#remove
      */
-    public void remove(List<Item> items, String id) throws IOException {
-      remove(items, getTopic(), id);
+    public void remove(String id, List<Item> items) throws IOException {
+      remove(getTopic(), id, items);
     }
 
     /**
-     * @see ItemSets::update
+     * @see ItemSets#update
      */
-    public void update(List<Item> items, String id) throws IOException {
-      update(items, getTopic(), id);
+    public void update(String id, List<Item> items) throws IOException {
+      update(getTopic(), id, items);
     }
 
     //--------------------------------------------------------------------------
@@ -336,31 +336,31 @@ public class ItemSets extends Organization {
     //--------------------------------------------------------------------------
 
     /**
-     * @see ItemSets::fetch
+     * @see ItemSets#fetch
      */
     public List<Item> fetch() throws IOException {
       return fetch(getId());
     }
 
     /**
-     * @see ItemSets::create
+     * @see ItemSets#create
      */
     public void create(List<Item> items) throws IOException {
-      create(items, getId());
+      create(getId(), items);
     }
 
     /**
-     * @see ItemSets::remove
+     * @see ItemSets#remove
      */
     public void remove(List<Item> items) throws IOException {
-      remove(items, getId());
+      remove(getId(), items);
     }
 
     /**
-     * @see ItemSets::update
+     * @see ItemSets#update
      */
     public void update(List<Item> items) throws IOException {
-      update(items, getId());
+      update(getId(), items);
     }
 
     //--------------------------------------------------------------------------
@@ -460,4 +460,4 @@ public class ItemSets extends Organization {
     private TYPE _type;
     private enum TYPE {BOOLEAN, NUMBER, STRING}
  }
-}
+}

data/src/main/java/com/infochimps/vayacondios/VCDIntegrationTest.java

@@ -6,6 +6,7 @@ import static com.infochimps.util.CurrentClass.getLogger;
 
 import static com.infochimps.vayacondios.ItemSets.Item;
 import static com.infochimps.vayacondios.ItemSets.ItemSet;
+import com.infochimps.vayacondios.ItemSets;
 
 import java.io.IOException;
 import java.util.Arrays;
@@ -19,32 +20,58 @@ public class VCDIntegrationTest {
   private static final int VCD_PORT = 8000;
   private static final Logger LOG = getLogger();
 
-  private static ItemSet newSet() {
+  private static ItemSets itemSets() {
     return new VayacondiosClient("localhost", VCD_PORT).
       organization("org").
-      itemsets().
-      topic("topic").
-      itemSet("id");
+      itemsets();
   }
 
-  private static void assertEquals(String... expectedStringArr)
-    throws IOException {
-    List<Item> items = newSet().fetch();
-    List<Item> expectedItems = new ArrayList();
-    List<Item> copy;
+  private static List<Item> buildItemList(String items[]) {
+    List<Item> result = new ArrayList<Item>();
+    for (String s : items) result.add(new Item(s));
+    return result;
+  }
 
-    for (String exp : expectedStringArr) expectedItems.add(new Item(exp));
+  private static List<String> getStrings(List<Item> items) {
+    List<String> result = new ArrayList<String>();
+    for (Item i : items) result.add(i.getAsString());
+    return result;
+  }
+
+  private static List<String> fetch() throws IOException {
+    return getStrings(itemSets().fetch("topic", "id"));
+  }
+
+  private static void create(String... items) throws IOException {
+    itemSets().create("topic", "id", buildItemList(items));
+  }
+
+  private static void remove(String... items) throws IOException {
+    itemSets().remove("topic", "id", buildItemList(items));
+  }
 
-    if (!items.containsAll(expectedItems)) {
-      copy = new ArrayList(); copy.addAll(expectedItems);
+  private static void update(String... items) throws IOException {
+    itemSets().update("topic", "id", buildItemList(items));
+  }
+
+  private static void assertEquals(String... expectedArr)
+    throws IOException {
+    List<String> items = fetch();
+    List<String> copy = new ArrayList<String>();
+    List<String> expected = Arrays.asList(expectedArr);
+
+    if (!items.containsAll(expected)) {
+      copy = new ArrayList(); copy.addAll(expected);
       LOG.trace("removing items. copy change? " + copy.removeAll(items));
       System.out.println("\033[31mFAIL\033[0m: expected but absent: " + copy);
-    }
-    if (!expectedItems.containsAll(items)) {
+    } else
+      System.out.println("\033[32mSUCCESS\033[0m: all expected items present");
+    if (!expected.containsAll(items)) {
       copy = new ArrayList(); copy.addAll(items);
-      LOG.trace("removing items. copy change? " + copy.removeAll(expectedItems));
+      LOG.trace("removing items. copy change? " + copy.removeAll(expected));
       System.out.println("\033[31mFAIL\033[0m: unexpected and present: " + copy);
-    }
+    } else
+      System.out.println("\033[32mSUCCESS\033[0m: no unexpected items present");
   }
 
   public static void main(String argv[]) {
@@ -53,11 +80,13 @@ public class VCDIntegrationTest {
     System.out.println("Running Vayacondios integration test...");
 
     try {
-      newSet().create(Arrays.asList(new Item("foo"), new Item("baz"), new Item("bar"), new Item("bing")));
+      create("foo", "baz", "bar", "bing");
       assertEquals("foo", "baz", "bar", "bing");
-      newSet().update(Arrays.asList(new Item("biff")));
+
+      update("biff");
       assertEquals("foo", "baz", "bar", "bing", "biff");
-      newSet().remove(Arrays.asList(new Item("biff"), new Item("bar")));
+
+      remove("biff", "bar");
       assertEquals("foo", "baz", "bing");
       
       System.out.println("Integration test complete.");

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vayacondios-server
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configliere
@@ -197,6 +197,7 @@ files:
 - config/http_shim.rb
 - config/vayacondios.example.yaml
 - config/vayacondios.yaml
+- examples/java/ItemSetTest.java
 - lib/tasks/publish.rake
 - lib/tasks/spec.rake
 - lib/tasks/yard.rake
@@ -243,6 +244,7 @@ files:
 - spec/server/server_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongo_cleaner.rb
+- src/main/java/ItemSetTest.java
 - src/main/java/com/infochimps/util/CurrentClass.java
 - src/main/java/com/infochimps/util/DebugUtil.java
 - src/main/java/com/infochimps/util/HttpHelper.java
@@ -267,7 +269,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1404485587736980248
+      hash: 1185484650458955760
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -276,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1404485587736980248
+      hash: 1185484650458955760
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25