@@ -23,30 +23,31 @@ import com.google.inject.name.Names; /** * Example GuiceModule binds everything together + * * @author bens */ public class GuiceModule extends SocialApiGuiceModule { - - @Override + + @Override protected void configure() { - super.configure(); - bind(String.class).annotatedWith(Names.named("shindig.canonical.json.db")) - .toInstance("sampledata/canonicaldb.json"); - + super.configure(); + bind(String.class).annotatedWith(Names.named("shindig.canonical.json.db")) + .toInstance("sampledata/canonicaldb.json"); + bind(ActivityService.class).to(JsonDbServiceExample.class); bind(AppDataService.class).to(JsonDbServiceExample.class); bind(PersonService.class).to(JsonDbServiceExample.class); bind(MessageService.class).to(JsonDbServiceExample.class); bind(RelationshipService.class).to(JsonDbServiceExample.class); - + bind(OAuthDataStore.class).to(SampleOAuthDataStore.class); requestStaticInjection(SampleRealm.class); - } - - @Override + } + + @Override protected Set<Object> getHandlers() { - return ImmutableSet.<Object>of(ActivityHandler.class, AppDataHandler.class, - PersonHandlerImpl.class, MessageHandler.class); + return ImmutableSet.<Object> of(ActivityHandler.class, + AppDataHandler.class, PersonHandlerImpl.class, MessageHandler.class); } } src/main/java/bbc/social/shindig/example/GuiceModule.java @@ -26,40 +26,40 @@ import com.google.inject.Inject; */ @Service(name = "people", path = "/{userId}+/{groupId}/{personId}+") public class PersonHandlerImpl extends PersonHandler { - private final RelationshipService relationshipService; + private final RelationshipService relationshipService; - @Inject - public PersonHandlerImpl(PersonService personService, - RelationshipService relationshipService, ContainerConfig config) { - super(personService, config); - this.relationshipService = relationshipService; - } + @Inject + public PersonHandlerImpl(PersonService personService, + RelationshipService relationshipService, ContainerConfig config) { + super(personService, config); + this.relationshipService = relationshipService; + } - /** - * Create a new friendship between 2 users POST - {id: 'friendId'} - * /people/{userId}/@friends - * - * @param request - * @return - * @throws ProtocolException - */ - @Operation(httpMethods = "POST", path = "/{userId}+/@friends") - public Future<?> createFriends(SocialRequestItem request) - throws ProtocolException { - Set<UserId> userIds = request.getUsers(); - Person person = request.getTypedParameter("body", Person.class); - HandlerPreconditions.requireNotEmpty(userIds, "No userId specified"); - HandlerPreconditions.requireSingular(userIds, - "Multiple userIds not supported"); + /** + * Create a new friendship between 2 users POST - {id: 'friendId'} + * /people/{userId}/@friends + * + * @param request + * @return + * @throws ProtocolException + */ + @Operation(httpMethods = "POST", path = "/{userId}+/@friends") + public Future<?> createFriends(SocialRequestItem request) + throws ProtocolException { + Set<UserId> userIds = request.getUsers(); + Person person = request.getTypedParameter("body", Person.class); + HandlerPreconditions.requireNotEmpty(userIds, "No userId specified"); + HandlerPreconditions.requireSingular(userIds, + "Multiple userIds not supported"); - if (person == null || person.getId() == null || person.getId().length() < 1) { - throw new IllegalArgumentException( - "Cannot create relationship without a person to befriend"); - } - UserId userId = userIds.iterator().next(); - this.relationshipService.createRelationship(userId.getUserId(request - .getToken()), person.getId()); + if (person == null || person.getId() == null || person.getId().length() < 1) { + throw new IllegalArgumentException( + "Cannot create relationship without a person to befriend"); + } + UserId userId = userIds.iterator().next(); + this.relationshipService.createRelationship(userId.getUserId(request + .getToken()), person.getId()); - return ImmediateFuture.newInstance(null); - } + return ImmediateFuture.newInstance(null); + } } src/main/java/bbc/social/shindig/example/handler/PersonHandlerImpl.java @@ -2,13 +2,15 @@ package bbc.social.shindig.example.service; /** * Relationship service provides interface to users' relationships + * * @author bens */ public interface RelationshipService { - /** - * Create a relationship between two users - * @param personId - * @param friendId - */ - public void createRelationship(String personId, String friendId); + /** + * Create a relationship between two users + * + * @param personId + * @param friendId + */ + public void createRelationship(String personId, String friendId); } src/main/java/bbc/social/shindig/example/service/RelationshipService.java @@ -12,42 +12,47 @@ import com.google.inject.Singleton; import com.google.inject.name.Named; /** - * Simple implementation stores relationships in JsonDb - * This nieve implementation makes a rather large assumption that friendships are uni-directional + * Simple implementation stores relationships in JsonDb This nieve + * implementation makes a rather large assumption that friendships are + * uni-directional + * * @author bens */ @Singleton -public class JsonDbServiceExample extends JsonDbOpensocialService implements RelationshipService { - - @Inject - public JsonDbServiceExample(@Named("shindig.canonical.json.db") - String jsonLocation, @Named("shindig.bean.converter.json") - BeanConverter converter) throws Exception { - super(jsonLocation, converter); +public class JsonDbServiceExample extends JsonDbOpensocialService implements + RelationshipService { + + @Inject + public JsonDbServiceExample( + @Named("shindig.canonical.json.db") String jsonLocation, + @Named("shindig.bean.converter.json") BeanConverter converter) + throws Exception { + super(jsonLocation, converter); } - /** {@inheritDoc} */ - public void createRelationship(String personId, String friendId) { - try { - if (this.getDb().getJSONObject("friendLinks").has(personId)) { - JSONArray friends = this.getDb().getJSONObject("friendLinks").getJSONArray(personId); - boolean found = false; - for (int i=0; i<friends.length(); i++) { - if (friends.getString(i).equals(friendId)) { - found = true; - } - } - if (!found) { - friends.put(friendId); - this.getDb().getJSONObject("friendLinks").put(personId, friends); - } - } else { - JSONArray friends = new JSONArray(); - friends.put(friendId); - this.getDb().getJSONObject("friendLinks").put(personId, friends); - } - } catch (JSONException e) { - throw new RuntimeException("unable to work with json db", e); - } - } + /** {@inheritDoc} */ + public void createRelationship(String personId, String friendId) { + try { + if (this.getDb().getJSONObject("friendLinks").has(personId)) { + JSONArray friends = this.getDb().getJSONObject("friendLinks") + .getJSONArray(personId); + boolean found = false; + for (int i = 0; i < friends.length(); i++) { + if (friends.getString(i).equals(friendId)) { + found = true; + } + } + if (!found) { + friends.put(friendId); + this.getDb().getJSONObject("friendLinks").put(personId, friends); + } + } else { + JSONArray friends = new JSONArray(); + friends.put(friendId); + this.getDb().getJSONObject("friendLinks").put(personId, friends); + } + } catch (JSONException e) { + throw new RuntimeException("unable to work with json db", e); + } + } } src/main/java/bbc/social/shindig/example/service/impl/JsonDbServiceExample.java @@ -49,32 +49,38 @@ import com.google.inject.TypeLiteral; import com.google.inject.name.Names; /** - * Duplication of https://svn.apache.org/repos/asf/incubator/shindig/trunk/java/social-api/src/test/java/org/apache/shindig/social/dataservice/integration/RestfulJsonPeopleTest.java - * Added create friends to show how to extend interface + * Duplication of + * https://svn.apache.org/repos/asf/incubator/shindig/trunk/java/social + * -api/src/test/java/org/apache/shindig/social/dataservice/integration/ + * RestfulJsonPeopleTest.java Added create friends to show how to extend + * interface + * * @author bens */ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { private Person canonical; - @SuppressWarnings({ "unchecked", "boxing" }) + @SuppressWarnings( { "unchecked", "boxing" }) @Override protected void setUp() throws Exception { - Injector injector = Guice.createInjector(new PropertiesModule(), new GuiceModule()); + Injector injector = Guice.createInjector(new PropertiesModule(), + new GuiceModule()); this.setResponse(EasyMock.createMock(HttpServletResponse.class)); - + // Set data service servlet DataServiceServlet servlet = new DataServiceServlet(); HandlerRegistry dispatcher = injector.getInstance(HandlerRegistry.class); - dispatcher.addHandlers(injector.getInstance(Key.get(new TypeLiteral<Set<Object>>(){}, - Names.named("org.apache.shindig.social.handlers")))); - + dispatcher.addHandlers(injector.getInstance(Key.get( + new TypeLiteral<Set<Object>>() { + }, Names.named("org.apache.shindig.social.handlers")))); + servlet.setHandlerRegistry(dispatcher); servlet.setBeanConverters(new BeanJsonConverter(injector), new BeanXStreamConverter(new XStream081Configuration(injector)), new BeanXStreamAtomConverter(new XStream081Configuration(injector))); this.setServlet(servlet); assertNotNull(servlet); - + NameImpl name = new NameImpl("Sir Shin H. Digg Social Butterfly"); name.setAdditionalName("H"); name.setFamilyName("Digg"); @@ -86,7 +92,8 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { canonical.setAboutMe("I have an example of every piece of data"); canonical.setActivities(Lists.newArrayList("Coding Shindig")); - Address address = new AddressImpl("PoBox 3565, 1 OpenStandards Way, Apache, CA"); + Address address = new AddressImpl( + "PoBox 3565, 1 OpenStandards Way, Apache, CA"); address.setCountry("US"); address.setLatitude(28.3043F); address.setLongitude(143.0859F); @@ -107,7 +114,8 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { bodyType.setWeight(74F); canonical.setBodyType(bodyType); - canonical.setBooks(Lists.newArrayList("The Cathedral & the Bazaar", "Catch 22")); + canonical.setBooks(Lists.newArrayList("The Cathedral & the Bazaar", + "Catch 22")); canonical.setCars(Lists.newArrayList("beetle", "prius")); canonical.setChildren("3"); AddressImpl location = new AddressImpl(); @@ -117,7 +125,8 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { canonical.setBirthday(new Date()); canonical.setDrinker(new EnumImpl<Drinker>(Drinker.SOCIALLY)); - ListField email = new ListFieldImpl("work", "shindig-dev@incubator.apache.org"); + ListField email = new ListFieldImpl("work", + "shindig-dev@incubator.apache.org"); canonical.setEmails(Lists.newArrayList(email)); canonical.setEthnicity("developer"); @@ -126,7 +135,8 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { canonical.setGender(Person.Gender.male); canonical.setHappiestWhen("coding"); canonical.setHasApp(true); - canonical.setHeroes(Lists.newArrayList("Doug Crockford", "Charles Babbage")); + canonical + .setHeroes(Lists.newArrayList("Doug Crockford", "Charles Babbage")); canonical.setHumor("none to speak of"); canonical.setInterests(Lists.newArrayList("PHP", "Java")); canonical.setJobInterests("will work for beer"); @@ -160,26 +170,30 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { canonical.setOrganizations(Lists.newArrayList(job1, job2)); canonical.setUpdated(new Date()); - canonical.setLanguagesSpoken(Lists.newArrayList("English", "Dutch", "Esperanto")); + canonical.setLanguagesSpoken(Lists.newArrayList("English", "Dutch", + "Esperanto")); canonical.setLivingArrangement("in a house"); - Enum<LookingFor> lookingForRandom = - new EnumImpl<LookingFor>(LookingFor.RANDOM, "Random"); - Enum<LookingFor> lookingForNetworking = - new EnumImpl<LookingFor>(LookingFor.NETWORKING, "Networking"); - canonical.setLookingFor(Lists.newArrayList(lookingForRandom, lookingForNetworking)); + Enum<LookingFor> lookingForRandom = new EnumImpl<LookingFor>( + LookingFor.RANDOM, "Random"); + Enum<LookingFor> lookingForNetworking = new EnumImpl<LookingFor>( + LookingFor.NETWORKING, "Networking"); + canonical.setLookingFor(Lists.newArrayList(lookingForRandom, + lookingForNetworking)); canonical.setMovies(Lists.newArrayList("Iron Man", "Nosferatu")); canonical.setMusic(Lists.newArrayList("Chieftains", "Beck")); - canonical.setNetworkPresence(new EnumImpl<NetworkPresence>(NetworkPresence.ONLINE)); + canonical.setNetworkPresence(new EnumImpl<NetworkPresence>( + NetworkPresence.ONLINE)); canonical.setNickname("diggy"); canonical.setPets("dog,cat"); - canonical.setPhoneNumbers(Lists.<ListField> newArrayList(new ListFieldImpl("work", - "111-111-111"), new ListFieldImpl("mobile", "999-999-999"))); + canonical.setPhoneNumbers(Lists.<ListField> newArrayList(new ListFieldImpl( + "work", "111-111-111"), new ListFieldImpl("mobile", "999-999-999"))); canonical.setPoliticalViews("open leaning"); - canonical.setProfileSong(new UrlImpl("http://www.example.org/songs/OnlyTheLonely.mp3", - "Feelin' blue", "road")); - canonical.setProfileVideo(new UrlImpl("http://www.example.org/videos/Thriller.flv", - "Thriller", "video")); + canonical.setProfileSong(new UrlImpl( + "http://www.example.org/songs/OnlyTheLonely.mp3", "Feelin' blue", + "road")); + canonical.setProfileVideo(new UrlImpl( + "http://www.example.org/videos/Thriller.flv", "Thriller", "video")); canonical.setQuotes(Lists.newArrayList("I am therfore I code", "Doh!")); canonical.setRelationshipStatus("married to my job"); @@ -197,11 +211,13 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { canonical.setTurnOns(Lists.newArrayList("well document code")); canonical.setTvShows(Lists.newArrayList("House", "Battlestar Galactica")); - canonical.setUrls(Lists.<Url>newArrayList( - new UrlImpl("http://www.example.org/?id=1", "my profile", "Profile"), - new UrlImpl("http://www.example.org/pic/?id=1", "my awesome picture", "Thumbnail"))); + canonical + .setUrls(Lists.<Url> newArrayList(new UrlImpl( + "http://www.example.org/?id=1", "my profile", "Profile"), + new UrlImpl("http://www.example.org/pic/?id=1", + "my awesome picture", "Thumbnail"))); } - + @Test public void testCreateFriends() throws Exception { Map<String, String> extraParams = Maps.newHashMap(); @@ -213,8 +229,8 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { extraParams.put("fields", null); // Currently, for Shindig @all == @friends - String resp = getResponse("/people/john.doe/@friends", "GET", extraParams, null, - ContentTypes.OUTPUT_JSON_CONTENT_TYPE); + String resp = getResponse("/people/john.doe/@friends", "GET", extraParams, + null, ContentTypes.OUTPUT_JSON_CONTENT_TYPE); JSONObject result = getJson(resp); assertEquals(3, result.getInt("totalResults")); @@ -225,22 +241,22 @@ public class RestfulJsonPeopleTest extends AbstractLargeRestfulTests { // The users should be in alphabetical order assertPerson(people.getJSONObject(0), "george.doe", "George Doe"); assertPerson(people.getJSONObject(1), "jane.doe", "Jane Doe"); - + String postData = "{id: 'canonical'}"; resp = getResponse("/people/john.doe/@friends", "POST", postData, null, ContentTypes.OUTPUT_JSON_CONTENT_TYPE); - + resp = getResponse("/people/john.doe/@friends", "GET", extraParams, null, ContentTypes.OUTPUT_JSON_CONTENT_TYPE); result = getJson(resp); assertEquals(4, result.getInt("totalResults")); } - - private void assertPerson(JSONObject person, String expectedId, String expectedName) - throws Exception { + + private void assertPerson(JSONObject person, String expectedId, + String expectedName) throws Exception { assertEquals(expectedId, person.getString("id")); - assertEquals(expectedName, person.getJSONObject("name").getString("formatted")); + assertEquals(expectedName, person.getJSONObject("name").getString( + "formatted")); } } - src/test/java/bbc/social/shindig/example/handler/RestfulJsonPeopleTest.java @@ -26,22 +26,24 @@ import com.google.inject.Injector; /** * Tests the example implementation of extended shindig service + * * @author bens */ public class JsonDbServiceExampleTest { - private static final UserId JOHN_DOE = new UserId(UserId.Type.userId, "john.doe"); - private SecurityToken token = new FakeGadgetToken(); - private JsonDbServiceExample service; - - @Before + private static final UserId JOHN_DOE = new UserId(UserId.Type.userId, + "john.doe"); + private SecurityToken token = new FakeGadgetToken(); + private JsonDbServiceExample service; + + @Before public void setUp() throws Exception { Injector injector = Guice.createInjector(new SocialApiTestsGuiceModule()); service = injector.getInstance(JsonDbServiceExample.class); } - - @Test - public void shouldCreateFriendship() throws Exception { - CollectionOptions options = new CollectionOptions(); + + @Test + public void shouldCreateFriendship() throws Exception { + CollectionOptions options = new CollectionOptions(); options.setSortBy(PersonService.TOP_FRIENDS_SORT); options.setSortOrder(SortOrder.ascending); options.setFilter(null); @@ -52,18 +54,18 @@ public class JsonDbServiceExampleTest { RestfulCollection<Person> responseItem = service.getPeople( ImmutableSet.of(JOHN_DOE), new GroupId(GroupId.Type.friends, null), - options, Collections.<String>emptySet(), token).get(); + options, Collections.<String> emptySet(), token).get(); assertNotNull(responseItem); assertEquals(3, responseItem.getTotalResults()); // Test a couple of users assertEquals("jane.doe", responseItem.getEntry().get(0).getId()); - + service.createRelationship("john.doe", "canonical"); - - responseItem = service.getPeople( - ImmutableSet.of(JOHN_DOE), new GroupId(GroupId.Type.friends, null), - options, Collections.<String>emptySet(), token).get(); + + responseItem = service.getPeople(ImmutableSet.of(JOHN_DOE), + new GroupId(GroupId.Type.friends, null), options, + Collections.<String> emptySet(), token).get(); assertNotNull(responseItem); assertEquals(4, responseItem.getTotalResults()); - } + } } src/test/java/bbc/social/shindig/example/service/JsonDbServiceExampleTest.java ffa15ad1e94187ea4ea7d0623570c08d62996594 Ben Smith ben@thesmith.co.uk http://github.com/thesmith/bbc-shindig-example/commit/9bc83b41e72ea33daac3371455f4bd9aaa27515c 9bc83b41e72ea33daac3371455f4bd9aaa27515c 2009-11-03T13:27:33-08:00 2009-11-03T13:27:33-08:00 fixed a load of formatting aa271aa563d805d169ff9cb958957f295e2d7664 Ben Smith ben@thesmith.co.uk