Merge pull request #6 from ccpmark/feature/free-busy-spaces

Free-busy spaces

Author: brianmuse

src/main/java/com/robinpowered/sdk/model/Busy.java

@@ -0,0 +1,64 @@
+package com.robinpowered.sdk.model;
+
+import org.joda.time.DateTime;
+
+import java.util.List;
+
+/**
+ * A period of time that a {@link Space} is unavailable for. <p>
+ *
+ * Contains a grouping of all events that occur within this unavailable block of time. When the
+ * gap between events is shorter than the duration requested, the events will be grouped
+ * together in a single Busy container.
+ */
+public class Busy {
+
+    /**
+     * Constants
+     */
+
+    public static final String MIME_TYPE = "vnd.robinpowered.busy.v1";
+
+
+    /**
+     * Properties
+     */
+
+    private DateTime from;
+    private DateTime to;
+    private List<SimpleEvent> events;
+
+
+    /**
+     * Methods
+     */
+
+    /**
+     * Constructor.
+     *
+     * @param from The start of the busy period.
+     * @param to The end of the busy period.
+     * @param events The {@link Event Events} occurring throughout the busy period.
+     */
+    public Busy(DateTime from, DateTime to, List<SimpleEvent> events) {
+        this.from = from;
+        this.to = to;
+        this.events = events;
+    }
+
+    public static String getMimeType() {
+        return MIME_TYPE;
+    }
+
+    public List<SimpleEvent> getSimpleEvents() {
+        return events;
+    }
+
+    public DateTime getFrom() {
+        return from;
+    }
+
+    public DateTime getTo() {
+        return to;
+    }
+}

src/main/java/com/robinpowered/sdk/model/FreeBusy.java

@@ -0,0 +1,17 @@
+package com.robinpowered.sdk.model;
+
+import java.util.List;
+
+/**
+ * An interface for Free-busy information returned for different models.
+ */
+public interface FreeBusy {
+
+    /**
+     * Returns a list of {@link Busy} intervals for which the given model is unavailable.
+     *
+     * @return A list of {@link Busy} intervals.
+     */
+    List<Busy> getBusy();
+
+}

src/main/java/com/robinpowered/sdk/model/FreeBusySpace.java

@@ -0,0 +1,57 @@
+package com.robinpowered.sdk.model;
+
+import java.util.List;
+
+/**
+ * Free-busy information returned for a given {@link Space} across a requested period of time. <p>
+ *
+ * Free-busy information describes the availability of a {@link Space} throughout a period of time
+ * by returning a set of {@link Busy} intervals which contain all events which overlap the requested
+ * period of time. The given space is available for the requested duration during any gaps between
+ * {@link Busy} models.
+ */
+public class FreeBusySpace implements ApiResponseModel, FreeBusy {
+
+    /**
+     * Constants
+     */
+
+    public static final String MIME_TYPE = "vnd.robinpowered.free-busy-space.v1";
+
+
+    /**
+     * Properties
+     */
+
+    private boolean hasPresence;
+    private Space space;
+    private List<Busy> busy;
+
+
+    /**
+     * Methods
+     */
+
+    public FreeBusySpace(boolean hasPresence, Space space, List<Busy> busy) {
+        this.hasPresence = hasPresence;
+        this.space = space;
+        this.busy = busy;
+    }
+
+    @Override
+    public String getMimeType() {
+        return MIME_TYPE;
+    }
+
+    public boolean hasPresence() {
+        return hasPresence;
+    }
+
+    public Space getSpace() {
+        return space;
+    }
+
+    public List<Busy> getBusy() {
+        return busy;
+    }
+}

src/main/java/com/robinpowered/sdk/model/SimpleEvent.java

@@ -0,0 +1,72 @@
+package com.robinpowered.sdk.model;
+
+import com.google.common.base.Objects;
+
+import org.joda.time.DateTime;
+
+/**
+ * A simplified {@link Event}.
+ *
+ * <p>
+ * A simplified version of an event containing start and end times, as well as a matching ID for
+ * referencing the associated {@link Event}.
+ */
+public class SimpleEvent implements ApiResponseModel {
+
+    /**
+     * Constants
+     */
+
+    public static final String MIME_TYPE = "vnd.robinpowered.simple-event.v1";
+
+
+    /**
+     * Properties
+     */
+
+    private int id;
+    private DateTime startedAt;
+    private DateTime endedAt;
+
+
+    /**
+     * Methods
+     */
+
+    /**
+     * Constructs a SimpleEvent.
+     *
+     * @param id The id of the event.
+     * @param startedAt When the event started.
+     * @param endedAt When the event ended.
+     */
+    public SimpleEvent(int id, DateTime startedAt, DateTime endedAt) {
+        this.id = id;
+        this.startedAt = startedAt;
+        this.endedAt = endedAt;
+    }
+
+    @Override
+    public boolean equals(Object that) {
+        if (this == that) return true;
+        if (that == null || !(that instanceof SimpleEvent)) return false;
+        return Objects.equal(id, ((SimpleEvent) that).id);
+    }
+
+    @Override
+    public String getMimeType() {
+        return MIME_TYPE;
+    }
+
+    public int getId() {
+        return id;
+    }
+
+    public DateTime getStartedAt() {
+        return startedAt;
+    }
+
+    public DateTime getEndedAt() {
+        return endedAt;
+    }
+}

src/main/java/com/robinpowered/sdk/service/EventService.java

@@ -3,7 +3,13 @@
 import com.robinpowered.sdk.http.DELETE;
 import com.robinpowered.sdk.model.ApiResponse;
 import com.robinpowered.sdk.model.Event;
+import com.robinpowered.sdk.model.FreeBusySpace;
 import com.robinpowered.sdk.model.User;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+
 import retrofit.Callback;
 import retrofit.http.Body;
 import retrofit.http.GET;
@@ -12,10 +18,6 @@
 import retrofit.http.Path;
 import retrofit.http.QueryMap;
 
-import java.io.IOException;
-import java.util.List;
-import java.util.Map;
-
 public interface EventService {
 
     // Sync
@@ -92,6 +94,14 @@ public interface EventService {
     @POST("/spaces/{spaceId}/events")
     void bookSpace(@Path("spaceId") int spaceId, @Body Event.Booking eventBooking, Callback<ApiResponse<Event>> callback);
 
+    // Sync
+    @GET("/free-busy/spaces")
+    ApiResponse<List<FreeBusySpace>> getFreeBusyForSpaces(@QueryMap Map<String, Object> options) throws IOException;
+
+    // Async
+    @GET("/free-busy/spaces")
+    void getFreeBusyForSpaces(@QueryMap Map<String, Object> options, Callback<ApiResponse<List<FreeBusySpace>>> callback);
+
 
     /**
      * For users