Home > Articles > Home & Office Computing > The Web/Virtual Worlds/Social Networking

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

2.7 Putting It All Together—Using the WeatherBug API

You’ll now build a service and widget that uses the WeatherBug API. (Note that zembly already provides a sample service and widget for the WeatherBug API. However, in this section you’ll build your own.) Here’s a summary of the steps you’ll follow to build this service and widget.

Steps to create the WeatherBugService

  1. Obtain a WeatherBug API key (from WeatherBug) and add it to your zembly Keychain.
  2. Create a new service to access the WeatherBug API.
  3. Add a parameter to the service.
  4. Using Find & Use, add the JavaScript code to call the WeatherBug API.
  5. Format the return data.
  6. Test and publish the service.

Steps to create the WeatherBugWidget

  1. Create a new blank widget.
  2. Provide HTML for formatting.
  3. Using Find & Use, add the call your WeatherBug service.
  4. Include the Prototype library.
  5. Add JavaScript code.
  6. Preview and publish the widget.
  7. Embed it in a web page.

Let’s begin. The WeatherBug API is included in the list of services you can access from zembly. These services have been wrapped as adapters by the zembly structure, giving you easy access to WeatherBug’s API.

Using Your Keychain

To start, access your Keychain (click Manage your Keychain from your home page). This displays the service providers currently supported on zembly. Scroll down to the WeatherBug’s listing, as shown in Figure 2.42.

Figure 2.42

Figure 2.42 Accessing WeatherBug’s registration page

The first step is to register with the WeatherBug service to obtain a key. You do this directly with WeatherBug. (Click Register with WeatherBug to get started.) After several email confirmations, WeatherBug will send you a key. When you add the WeatherBug API key to your keychain, zembly prompts for your name. (Each API site has its own requirements for what constitutes a legal API key.) Your name is stored with the key in your private keychain data.

zembly knows this key is associated with the WeatherBug API. When you access the WeatherBug API using Owner.keychain, the WeatherBug key is used in exactly the correct format required by WeatherBug. Also, when other people use a service you build, they access the service using your key. Your key is protected since it is wrapped in the Keychain mechanism.

Building WeatherBugService

Now that you have a WeatherBug key, you can build a service. From your Keychain page, scroll down to the WeatherBug listing and click Check out the services offered by WeatherBug. This directs you to the list of services; currently LiveWeatherRSS is the only one. Now click on WeatherBug.LiveWeatherRSS and zembly directs you to the LiveWeatherRSS page, as shown in Figure 2.43.

Figure 2.43

Figure 2.43 Drilling down to check out the services offered by WeatherBug

The WeatherBug.LiveWeatherRSS information page describes how to call the adapter and use its data. Besides the description, the page provides information on the parameters and error codes and a text box tells you how to call the adapter from a service.

Here’s the code template to access the LiveWeatherRSS adapter.

var result = Things.WeatherBug.LiveWeatherRSS({
     zipcode: "", // 5-digit ZipCode, U.S. cities only
     // unittype: "", // Optional. Default value is 1. Values are 0
     // (US customary units) or 1 (metric units - kms, degrees Celsius, etc).
     keys: Owner.keychain
 });

The LiveWeatherRSS API call takes three parameters: the target zip code, the unit type (this is optional, but it defaults to ‘1’ which means metric units), and keys. When you build this service, you’ll supply values for unit type and keys and allow the user to supply the target zip code.

Now, let’s build the service. Click 26inline01.jpg at the top of the page and choose Service from the drop down menu. For this service, you’ll have a single parameter (the target zip code). The unit type defaults to “1” (metric units) but you’ll specify U.S. units (such as Fahrenheit and inches) which is “0”. For the keys data use Owner.key-chain, which pulls your WeatherBug-specific API key. You write this service using JavaScript. The LiveWeatherRSS service returns XML. You’ll extract just the data you want and return the results to the caller in JSON.

Using E4X and JavaScript

zembly returns XML data as a DOM document object. This means that you can access the object directly in your JavaScript using E4X notation.

Listing 2.6 shows a sample of the XML response from WeatherBug. Let’s show you how to access the various nodes using JavaScript and E4X.

Listing 2.6. Sample XML Response from WeatherBug

<rss version="2.0">
   <channel>
      <title>Observations from Encinitas,  CA - USA</title>
      <link>...</link>
      <description> . . . (contains HTML code) . . . </description>
         . . . omitted data . . .
   </channel>
</rss>

Because the data is already returned as a DOM document object, you access node title using (for example),

data.channel.title

As discussed earlier, you provide a single parameter (“zipcode”), which is a String, it’s required, and is escaped, as shown in Figure 2.44.

Figure 2.44

Figure 2.44 Editing a parameter

To add the code you need to call the adapter to the editor, select the Find & Use tab in the box to the right of the editor. Specify LiveWeatherRSS and click Search. zembly returns the matching services. Click Add to editor and zembly adds the code you need to the editor, as shown in Figure 2.45.

Figure 2.45

Figure 2.45 Find & Use lets you search for services and add code to the editor

Listing 2.7 shows the JavaScript source for WeatherBugService. Function Log.write allows you to write information to a log file that you can view in the Call window to the right of the editor. Select Log at the bottom of the Call window to view. Here, function Log.write(typeof data) writes “xml” to the log file.

Using the E4X notation, the WeatherBugService extracts the data for the title, description, and link to pass to the caller. This is the data you’ll work with when you create a widget that uses this service.

Listing 2.7. WeatherBugService (JavaScript)

var data = Things.WeatherBug.LiveWeatherRSS({
   "zipcode": Parameters.zipcode, // 5-digit ZipCode, U.S. cities only
   "unittype": "0",
   "keys": Owner.keychain
});

//log type of the result object (XML object)
Log.write(typeof data); // writes "xml"

//You can use E4X notation to access the elements and attributes
//inside this object directly

var result = new Object();

result.title = ""+data.channel.item.title;
result.description = ""+data.channel.item.description;
result.link = ""+data.channel.link;

// Returns JSON
return result;

As you build the service, you can test drive it and look at the results that are returned.

Calling WeatherBugService

The next step is to build a widget that uses this service. The point of building a widget is to create a user-friendly snippet of code that others can paste directly into a web page. This widget should provide nice formatting of the data returned by WeatherBugService. Before leaving the WeatherBugService page, you’ll see that it tells you how to call this service from a widget. Here is the template code zembly provides.

Things.callService("ganderson.WeatherBugService",
 {
     zipcode: "" // 5-digit ZipCode, U.S. cities only
 },
 {
     onSuccess: function(data) {
         Log.write(data);
     },
     onFailure: function(error) {
         Log.write("Error: " + error.code + " : " + error.message);
     }
 });

When you build your widget, you’ll use this code to call the service. Let’s take a brief look at the response you get when you make a successful call to a service (the onSuccess handler). The code within Things.callService examines the response and gives you a pointer to the data object directly (as the first argument).

  • If the service returns an object (if the response content type is application/json), then data is a JavaScript object. The WeatherBugService returns JSON data to the calling widget.
  • If the service returns an XML document (if the response content type is application/xml), then data is a DOM object.
  • If the service returns a plain string, number, boolean or date, then the data object will have its string representation. The LoanPaymentService returns a number, which will have its string representation in the calling widget.

Note that the onFailure handler accesses the error object.

Building WeatherBugWidget

From the top of the page, click 26inline01.jpg and select Widget from the drop down menu. Choose Create a blank widget. The widget page lets you rename the widget, provide a description, and specify HTML, CSS, and JavaScript code. The HTML code should provide an input field for the zip code and a button to click and grab the weather data. You’ll also need a named <div> tag to display the results. (This is id="weatherBugResults" in Listing 2.8 below.)

Here is the HTML code for the WeatherBugWidget.

Listing 2.8. WeatherBugWidget (HTML)

<div id="weatherBugWidget">
   Please enter a ZipCode to search WeatherBug service: <br/>
   <input id="zipcode" type="text" value="92024" />
   <br/>
   <button id="weatherButton">Get Weather</button>
   <br/><hr/><br/>
   <div id="weatherBugResults"></div>
</div>

Sample JSON Output

Before you look at the JavaScript code for this widget, let’s look at the data that the service returns. Listing 2.9 shows sample JSON output (property description has been shortened). The result object is embedded in curly braces { } and each property is identified in quotation marks followed by a colon and its value. Properties are separated with commas.

Because the data arrives to the caller as a JavaScript object, you do not need to perform any parsing. For example, the title property is accessed using (for example)

data.title

Listing 2.9. Sample JSON Output

{
   "title": "Live Conditions from Encinitas,  CA - USA",
   "description":
"<img src=\"http://deskwx.weatherbug.com/images/Forecast/icons/cond026.gif\"
      border=\"0\" alt=\"Current Conditions\"/>

      ( . . . data omitted . . . )

   <br />",
   "link":
   "http://weather.weatherbug.com/CA/Encinitas
weather.html?ZCode=Z5546&Units=0&stat=ENCNT"
}

WeatherBugWidget JavaScript

This widget doesn’t specify any CSS. Listing 2.10 shows the JavaScript code for this widget. Note that each property in the returned data object (data) is accessed directly using JavaScript notation. Since the data in property description is straight HTML, you can use that directly in the HTML markup.

Listing 2.10. WeatherBugWidget (JavaScript)

// WeatherBugWidget (WBW)
// Register a listener for the "weatherButton" with Prototype Event.observe
Event.observe($("weatherButton"), 'click', function() {
   var zipcode = $("zipcode").value;
   // call service and pass zipcode
   Things.callService("ganderson.WeatherBugService", {
      zipcode: zipcode},
      {
      onSuccess: function(data) {
         // format the return data and inject into page markup
         var resultsHtml = "<b>" + data.title + "</b><br/>" +
            data.description + "<br/><b><a href=" + data.link +
            ">weather details</a></b><br/> " ;
         $("weatherBugResults").innerHTML = resultsHtml;
      },
      onFailure: function(error) {alert(error.code);}
   });
});

Each time you edit the widget, you can test it directly on the widget page. Once you’re finished editing, publish it. zembly provides the code you use to run the widget in a browser. You can configure the iframe by specifying height and width attributes. Here is the HTML source.

Listing 2.11. Sample HTML source to call the WeatherBugWidget

<iframe width=500 height="350"
   src="https://0eb6e21170b8405ca2658cec54fc5005.zembly.com/things/
0eb6e21170b8405ca2658cec54fc5005;iframe" frameborder="0">
</iframe>

Figure 2.46 shows sample output from running the above HTML.

Figure 2.46

Figure 2.46 WeatherBugWidget running in a browser

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020