Initial commit

wink-travel · Oct 30, 2022 · 7dcbc7f · 7dcbc7f
1 parent 06cdd4c
commit 7dcbc7f
Show file tree

Hide file tree

Showing 6 changed files with 894 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,30 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+/booking-engine-sdk-java/target/
+
+target/
+!.mvn/wrapper/maven-wrapper.jar
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.nb-gradle/
diff --git a/README.md b/README.md
@@ -1,2 +1,272 @@
-# iam-sdk-java
-Spring-aware OAuth2 support library for our Java SDKs
+[![wink.travel logo](https://res.cloudinary.com/traveliko/image/upload/c_scale,h_75/v1653285543/wink/logo_text.png)](https://wink.travel)
+
+# Wink Java SDK
+
+Welcome to the Java SDK that enables you to communicate with all that the Wink platform has to offer.
+
+## Getting started
+This SDK contains libraries you can leverage to communicate with the Wink platform.
+
+### Java Requirements
+Maven artifacts were compiled with Java 17. Java 1.8 is the lowest supported version.
+
+Spring is not required but we highly recommend you use. Our examples will be based on how to do it the "Spring way".
+
+Download libraries from Maven Central Repository.
+
+### Affiliate
+
+[API documentation](https://docs.wink.travel/affiliate)
+
+The Affiliate API exposes endpoints for affiliates who want browse available platform inventory and then prepare that inventory for sale, such as shareable links, grids, cards, maps etc. An affiliate can also track their ranking on our leaderboards as well as detail platform-level analytics.
+
+```
+<dependency>
+<groupId>travel.wink</groupId>
+<artifactId>affiliate-sdk-java</artifactId>
+<packaging>jar</packaging>
+<version><!-- see Releases --></version>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(AffiliateSDKConfiguration.class) or run a component scan over `travel.wink.sdk.affiliate` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- ApplicationApi: Manage your API keys via the ApplicationApi. 
+- BookingsApi: View all your bookings.
+- CampaignApi: Used by our WordPress Affiliate plugin to query for inventory you have created and is ready for sale.
+- CompanyApi: Manage your accounts through the company API.
+- CustomizationApi: Manage your customizations through the Customization API.
+- DiscoverApi: See which countries and cities we have available inventory in as well as retrieve inventory available for sale through you channels. 
+- HotelRelationshipRequestApi: Search for and request direct relationships with hotels. 
+- InventoryCardsApi: Manage your single inventory "cards" through the Inventory Cards API.
+- InventoryGridsApi: Manage your inventory "grids" through the Inventory Grids API.
+- InvoiceApi: If you are subscribing to any of our services, you can retrieve invoices with the Invoice API. (Note: Currently not in use. No available services.) 
+- MapsApi: Manage your maps through the Maps API.
+- NotificationApi: Receive and reply to platform notifications with the Notification API.
+- ShareableLinksApi: Manage links you can share and track across your sales channels.
+- TestApi: Endpoint to check that your integration works.
+
+### Analytics
+
+[API documentation](https://docs.wink.travel/analytics)
+
+The Analytics API gives you access to time series data on a variety of data sources to measure bookings and insights on properties, affiliates and traveler data.
+
+```
+<dependency>
+<groupId>travel.wink</groupId>
+<artifactId>analytics-sdk-java</artifactId>
+<packaging>jar</packaging>
+<version><!-- see Releases --></version>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(AffiliateSDKConfiguration.class) or run a component scan over `travel.wink.sdk.analytics` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- AnalyticsApi: Create analytics that is meaningful to you. We provide the filters, sorting mechanisms and data points you need to track everything you want on our platform.
+- LeaderboardApi: Track where you stand compared to other affiliates. The metric is bookings.
+- TestApi: Endpoint to check that your integration works.
+
+### Booking
+
+[API documentation](https://docs.wink.travel/booking)
+
+The Booking API exposes creating bookings as either a platform merchant or agent. 
+
+```
+<dependency>
+  <groupId>travel.wink</groupId>
+  <artifactId>booking-sdk-java</artifactId>
+  <version><!-- see Releases --></version>
+  <packaging>jar</packaging>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(BookingEngineSDKConfiguration.class) or run a component scan over `travel.wink.sdk.booking` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- BookingApi: Everything related to viewing, creating and cancelling bookings.
+
+### Channel manager
+
+[API documentation](https://docs.wink.travel/channel-manager)
+
+The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties.  
+
+```
+<dependency>
+  <groupId>travel.wink</groupId>
+  <artifactId>channel-manager-sdk-java</artifactId>
+  <version><!-- see Releases --></version>
+  <packaging>jar</packaging>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(ChannelManagerSDKConfiguration.class) or run a component scan over `travel.wink.sdk.channel.manager` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- ChannelManagerApi: Everything related to pushing rates and availability as well as querying properties managed by your channel manager account with us.
+
+### Extranet
+
+[API documentation](https://docs.wink.travel/extranet)
+
+The Extranet API exposes endpoints for managing all aspects of a property on our platform. A hotelier can manage content, rates, sales channels for every type of inventory we offer as well as gain valuable platform-level insight into the health of their property.
+
+```
+<dependency>
+  <groupId>travel.wink</groupId>
+  <artifactId>extranet-sdk-java</artifactId>
+  <version><!-- see Releases --></version>
+  <packaging>jar</packaging>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(ExtranetSDKConfiguration.class) or run a component scan over `travel.wink.sdk.extranet` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- AccessApi: Manage which users get to manage your properties with the Access API.
+- ActivityApi: Manage activities guests can book / view along with their room with the Activity API.
+- AddOnApi: Manage add-ons guests can book / view along with their room with the Add-On API.
+- AffiliateApi: Search for, and connect with, affiliates you would like to work with directly using the Affiliate API.
+- AnalyticsApi: Create analytics that is meaningful to you. We provide the filters, sorting mechanisms and data points you need to track everything you want on our platform.
+- AnnouncementApi: Manage property announcements would-be guests should know about before booking using the Announcement API.
+- AttractionApi: Manage attraction guests can book / view along with their room with the Activity API.
+- BookingApi: Manage bookings and cancellations with the Booking API.
+- CalDavApi: Integrate you favorite calendar application with your bookings so you can see who's coming with the CalDAV API.
+- CancellationPolicyApi: Manage property cancellation policies with the Cancellation Policy API.
+- ContactsApi: Manage property contacts with the Contacts API.
+- DailyRateApi: Manage Master Rate rates with the Daily Rate API.
+- GeoNameApi: Query standard geo-name data from the platform to see which locations we support using the Geo Name API. 
+- GeoLocationApi: Manage property geo-location with the Geo Location API.
+- GuestRoomApi: Manage room type inventory including images and video with the Guest Room API.
+- InventoryApi: Manage sales channel access to your inventory with the Inventory API.
+- InvoiceApi: If you are subscribing to any of our services, you can retrieve invoices with the Invoice API. (Note: Currently not in use. No available services.) 
+- LeaderboardApi: Track how affiliates are doing in comparison to other affiliates on the platform and get an idea of whom the real producers are with the Leaderboard API. 
+- LifestyleApi: Manage the lifestyles the property caters best to with the Lifestyle API.
+- MasterRateApi: Manage master rates (pair of guest room and rate plan) with the Master Rate API.
+- MediaApi: Manage property media files including images and video with the Media API.
+- MeetingRoomApi: Manage activities guests can book / view along with their room with the Activity API.
+- NotificationApi: Receive and reply to platform notifications with the Notification API.
+- OnboardingApi: Use the Onboarding API to add your property. This is always the first API call you make for a new property.
+- PackageApi: Manage packages guests can book / view along with their room with the Activity API.
+- PlaceApi: Manage places guests can book / view along with their room with the Activity API.
+- PolicyApi: Manage property policy with the Policy API.
+- PromotionApi: Manage promotions with the Promotion API.
+- PromotionBundleApi: Manage more complex promotion bundles with the Promotion Bundle API.
+- PropertyApi: Manage basic property information with the Property API.
+- RatePlanApi: Manage rate plans with the Rate Plan API.
+- RecognitionApi: Manage awards, publications, ratings and reviews the property has received with the Recognition API.
+- ReferenceApi: Look up reference / OTA spec codes and their meaning with the Reference API. 
+- RestaurantApi: Manage restaurant guests can book / view along with their room with the Activity API.
+- ReviewApi: View and respond to reviews from customers with the Review API.
+- SalesChannelApi: Manage sale channel relationships with the Sales Channel API.
+- SchedulerApi: Manage the calendar schedule for all facilities and ancillary inventory with the Scheduler API.
+- SocialNetworkApi: Manage property social networks using the Social Network API.
+- SpaApi: Manage spa guests can book / view along with their room with the Activity API.
+- TestApi: Easy way to check if you are connected and authenticated with the Wink platform.
+
+### Inventory
+
+[API documentation](https://docs.wink.travel/inventory)
+
+The Inventory API exposes way to retrieve more information about known inventory that was first found via the Lookup API.
+
+```
+<dependency>
+  <groupId>travel.wink</groupId>
+  <artifactId>inventory-sdk-java</artifactId>
+  <version><!-- see Releases --></version>
+  <packaging>jar</packaging>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(InventorySDKConfiguration.class) or run a component scan over `travel.wink.sdk.inventory` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- InventoryApi: Everything related to querying property availability.
+
+
+### Lookup
+
+[API documentation](https://docs.wink.travel/lookup)
+
+The Lookup API exposes search functionality for finding available hotels to book. Hotels can be filtered on a variety of common filters as well as Wink-only filters.
+
+```
+<dependency>
+  <groupId>travel.wink</groupId>
+  <artifactId>lookup-sdk-java</artifactId>
+  <version><!-- see Releases --></version>
+  <packaging>jar</packaging>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(LookupSDKConfiguration.class) or run a component scan over `travel.wink.sdk.lookup` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- LookupApi: Everything related to querying for best priced room types using various filter mechanisms
+
+### Reference
+
+[API documentation](https://docs.wink.travel/reference)
+
+The Reference API exposes all our platform-level related taxonomies and codes necessary to create inventory on our platform. It can also be used to retrieve geo-location information.
+
+```
+<dependency>
+  <groupId>travel.wink</groupId>
+  <artifactId>reference-sdk-java</artifactId>
+  <version><!-- see Releases --></version>
+  <packaging>jar</packaging>
+</dependency>
+```
+
+#### Usage
+
+Using Spring, @Import(ReferenceSDKConfiguration.class) or run a component scan over `travel.wink.sdk.reference` and `travel.wink.sdk.support`. That will give you access to the following Spring Beans:
+
+- GeoNameApi: Find geo-name lookup data from geonames.org.
+- ReferenceApi: Everything related to structured datasets and their meaning. E.g. OTA Room View Code list
+
+## Configuration
+You will need a client ID and a client secret to communicate with any of the Wink platform endpoints. You can create your account and get your credentials here:
+
+[https://sell.wink.travel](https://sell.wink.travel)
+
+Steps: 
+1. Register your personal user account
+2. Log in
+3. Create your first account
+4. Select that account
+5. Choose to create an Application for that account 
+6. The application will hold your credentials
+
+### Spring users
+Add your credentials to your property file:
+
+1. wink.travel.client.id=YOUR_CLIENT_ID
+2. wink.travel.client.secret=YOUR_CLIENT_SECRET
+
+### Non-Spring users
+Create 2 environment variables in your preferred way:
+
+1. WINK_TRAVEL_CLIENT_ID=YOUR_CLIENT_ID
+2. WINK_TRAVEL_CLIENT_SECRET=YOUR_CLIENT_SECRET
+
+## You might also be interested in...
+If you are developing for WordPress, we've [probably] got you covered. Check out our WordPress plugin:
+
+- TripPay Java SDK repo: [https://github.com/wink-travel/trip-pay-sdk-java](https://github.com/wink-travel/trip-pay-sdk-java)
+- Wink WordPress plugin repo: [https://github.com/wink-travel/affiliate-wordpress-plugin](https://github.com/wink-travel/affiliate-wordpress-plugin)
+- Wink WordPress Divi plugin repo: [https://github.com/wink-travel/affiliate-wordpress-divi-plugin](https://github.com/wink-travel/affiliate-wordpress-divi-plugin)
+- WordPress: [https://wordpress.org/plugins/iko-travel-affiliate/](https://wordpress.org/plugins/iko-travel-affiliate/) 
diff --git a/oauth2-web-client/pom.xml b/oauth2-web-client/pom.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>travel.wink</groupId>
+        <artifactId>wink-sdk-java</artifactId>
+        <version>22.1.9-SNAPSHOT</version>
+    </parent>
+    <artifactId>oauth2-web-client</artifactId>
+    <packaging>jar</packaging>
+    <name>OAuth2-enabled WebClient</name>
+    <description>All ApiClients want to use this to be able to support client credential-based authentication</description>
+
+
+</project>
diff --git a/oauth2-web-client/src/main/java/travel/wink/sdk/support/OAuth2WebClientConfiguration.java b/oauth2-web-client/src/main/java/travel/wink/sdk/support/OAuth2WebClientConfiguration.java
@@ -0,0 +1,71 @@
+package travel.wink.sdk.support;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.oauth2.client.AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager;
+import org.springframework.security.oauth2.client.InMemoryReactiveOAuth2AuthorizedClientService;
+import org.springframework.security.oauth2.client.ReactiveOAuth2AuthorizedClientService;
+import org.springframework.security.oauth2.client.registration.ClientRegistration;
+import org.springframework.security.oauth2.client.registration.InMemoryReactiveClientRegistrationRepository;
+import org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository;
+import org.springframework.security.oauth2.client.web.reactive.function.client.ServerOAuth2AuthorizedClientExchangeFilterFunction;
+import org.springframework.security.oauth2.core.AuthorizationGrantType;
+import org.springframework.web.reactive.function.client.WebClient;
+
+/**
+ * Created on: 8/8/21.
+ *
+ * @author Bjorn Harvold
+ * Responsibility:
+ */
+@Configuration
+public class OAuth2WebClientConfiguration {
+    @Value("${wink.travel.token-uri:https://iam.wink.travel/oauth/token}")
+    private String tokenUri;
+
+    @Value("${wink.travel.client.id}")
+    private String clientId;
+
+    @Value("${wink.travel.client.secret}")
+    private String clientSecret;
+
+    @Value("${wink.travel.scopes:inventory.read,inventory.write,inventory.remove,payment.read,payment.write,payment.remove}")
+    private String scope;
+
+    @Bean(name = "oauth2WebClient")
+    WebClient webClient() {
+        ServerOAuth2AuthorizedClientExchangeFilterFunction oauth = new ServerOAuth2AuthorizedClientExchangeFilterFunction(
+                new AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager(
+                        reactiveClientRegistrationRepository(),
+                        reactiveOAuth2AuthorizedClientService()
+                        )
+        );
+        oauth.setDefaultClientRegistrationId("wink-travel");
+        return WebClient.builder()
+                .filter(oauth)
+                .build();
+    }
+
+    @Bean
+    ReactiveOAuth2AuthorizedClientService reactiveOAuth2AuthorizedClientService() {
+        return new InMemoryReactiveOAuth2AuthorizedClientService(reactiveClientRegistrationRepository());
+    }
+
+    @Bean
+    ReactiveClientRegistrationRepository reactiveClientRegistrationRepository() {
+        return new InMemoryReactiveClientRegistrationRepository(clientRegistration());
+    }
+
+    @Bean
+    ClientRegistration clientRegistration() {
+        return ClientRegistration
+                .withRegistrationId("wink-travel")
+                .tokenUri(tokenUri)
+                .clientId(clientId)
+                .clientSecret(clientSecret)
+                .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS)
+                .scope(scope)
+                .build();
+    }
+}