allow channel to be updated via API
This commit is contained in:
Lee Lawlor
parent
f847e29268
commit
a7ba0eae18
@ -179,14 +179,19 @@ class ChannelsController < ApplicationController
|
||||
|
||||
|
||||
def update
|
||||
@channel = current_user.channels.find(params[:id])
|
||||
# get the current user or find the user via their api key
|
||||
@user = current_user || User.find_by_api_key(get_apikey)
|
||||
@channel = @user.channels.find(params[:id])
|
||||
|
||||
# make updating attributes easier for updates via api
|
||||
params[:channel] = params if params[:channel].blank?
|
||||
|
||||
if params["channel"]["video_type"].blank? && !params["channel"]["video_id"].blank?
|
||||
@channel.errors.add(:base, t(:channel_video_type_blank))
|
||||
end
|
||||
|
||||
if @channel.errors.count <= 0
|
||||
@channel.save_tags(params[:tags][:name])
|
||||
@channel.save_tags(params[:tags][:name]) if params[:tags].present?
|
||||
@channel.assign_attributes(channel_params)
|
||||
@channel.set_windows
|
||||
@channel.save
|
||||
@ -196,7 +201,11 @@ class ChannelsController < ApplicationController
|
||||
end
|
||||
|
||||
flash[:notice] = t(:channel_update_success)
|
||||
redirect_to channel_path(@channel.id)
|
||||
respond_to do |format|
|
||||
format.json { render :json => @channel.to_json(Channel.private_options) }
|
||||
format.xml { render :xml => @channel.to_xml(Channel.private_options) }
|
||||
format.any { redirect_to channel_path(@channel.id) }
|
||||
end
|
||||
end
|
||||
|
||||
def create
|
||||
|
||||
@ -12,16 +12,16 @@
|
||||
|
||||
<% if params[:action] == 'channels' %>
|
||||
<li><a href="#channels">Channels</a></li>
|
||||
<li class="subitem"><a href="#keywords">Keywords</a></li>
|
||||
<li class="subitem"><a href="#urls">Base URLs</a></li>
|
||||
<li class="subitem"><a href="#keywords">Keywords & URLs</a></li>
|
||||
<li class="subitem"><a href="#api_keys">API Keys</a></li>
|
||||
<li class="subitem"><a href="#rate_limits">Rate Limits / Caching</a></li>
|
||||
<li class="subitem"><a href="#update">Update Channel Feed</a></li>
|
||||
<li class="subitem"><a href="#update_feed">Update Channel Feed</a></li>
|
||||
<li class="subitem"><a href="#get_feed">Get Channel Feed</a></li>
|
||||
<li class="subitem"><a href="#get_field">Get Channel Field Feed</a></li>
|
||||
<li class="subitem"><a href="#get_status">Get Status Updates</a></li>
|
||||
<li class="subitem"><a href="#index">List Channels</a></li>
|
||||
<li class="subitem"><a href="#create">Create a Channel</a></li>
|
||||
<li class="subitem"><a href="#update">Update a Channel</a></li>
|
||||
<li class="subitem"><a href="#clear">Clear a Channel</a></li>
|
||||
<li class="subitem"><a href="#delete">Delete a Channel</a></li>
|
||||
<li class="subitem"><a href="#importer">Importer</a></li>
|
||||
|
||||
@ -102,7 +102,7 @@
|
||||
<br><br><br><br><br><br><br><br><br><br><br><br><br><br>
|
||||
|
||||
<hr />
|
||||
<%= render 'docs/channels/update' %>
|
||||
<%= render 'docs/channels/update_feed' %>
|
||||
|
||||
<hr />
|
||||
<%= render 'docs/channels/feed' %>
|
||||
@ -119,6 +119,9 @@
|
||||
<hr />
|
||||
<%= render 'docs/channels/create' %>
|
||||
|
||||
<hr />
|
||||
<%= render 'docs/channels/update' %>
|
||||
|
||||
<hr />
|
||||
<%= render 'docs/channels/clear' %>
|
||||
|
||||
|
||||
@ -1,99 +1,104 @@
|
||||
<div>
|
||||
<%= render 'response' %>
|
||||
<h2 id="update">Update Channel Feed</h2>
|
||||
<h2 id="update">Update a Channel</h2>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
To update a Channel feed, send an HTTP GET or POST to<br>
|
||||
<code><%= @ssl_api_domain %>update<span class="format format-json">.json</span><span class="format format-xml">.xml</span></code> .
|
||||
To update a Channel, send an HTTP PUT to
|
||||
<br><code><%= @ssl_api_domain %>channels/<span class="customcode">CHANNEL_ID</span><span class="format format-json">.json</span><span class="format format-xml">.xml</span></code> .
|
||||
|
||||
<br><br>
|
||||
Valid parameters:
|
||||
<ul>
|
||||
<li><b>api_key</b> (string) - Write API Key for this specific Channel (required). The Write API Key can optionally be sent via an X-THINGSPEAKAPIKEY HTTP header.</li>
|
||||
<li><b>field1</b> (string) - Field 1 data (optional)</li>
|
||||
<li><b>field2</b> (string) - Field 2 data (optional)</li>
|
||||
<li><b>field3</b> (string) - Field 3 data (optional)</li>
|
||||
<li><b>field4</b> (string) - Field 4 data (optional)</li>
|
||||
<li><b>field5</b> (string) - Field 5 data (optional)</li>
|
||||
<li><b>field6</b> (string) - Field 6 data (optional)</li>
|
||||
<li><b>field7</b> (string) - Field 7 data (optional)</li>
|
||||
<li><b>field8</b> (string) - Field 8 data (optional)</li>
|
||||
<li><b>lat</b> (decimal) - Latitude in degrees (optional)</li>
|
||||
<li><b>long</b> (decimal) - Longitude in degrees (optional)</li>
|
||||
<li><b>api_key</b> (string) - User's API Key; please note that this is different than a Channel API key, and can be found in <a href="/account">your account details</a>. (required).</li>
|
||||
<li><b>description</b> (string) - Description of the Channel (optional)</li>
|
||||
<li><b>elevation</b> (integer) - Elevation in meters (optional)</li>
|
||||
<li><b>status</b> (string) - Status update message (optional)</li>
|
||||
<li><b>twitter</b> (string) - Twitter username linked to <a href="/docs/thingtweet">ThingTweet</a> (optional)</li>
|
||||
<li><b>tweet</b> (string) - Twitter status update; see <a href="/docs/thingtweet#update">updating ThingTweet</a> for more info (optional)</li>
|
||||
<li><b>created_at</b> (datetime) - Date when this feed entry was created, in the format<br>YYYY-MM-DD%20HH:NN:SS (optional)</li>
|
||||
<li><b>field1</b> (string) - Field1 name (optional)</li>
|
||||
<li><b>field2</b> (string) - Field2 name (optional)</li>
|
||||
<li><b>field3</b> (string) - Field3 name (optional)</li>
|
||||
<li><b>field4</b> (string) - Field4 name (optional)</li>
|
||||
<li><b>field5</b> (string) - Field5 name (optional)</li>
|
||||
<li><b>field6</b> (string) - Field6 name (optional)</li>
|
||||
<li><b>field7</b> (string) - Field7 name (optional)</li>
|
||||
<li><b>field8</b> (string) - Field8 name (optional)</li>
|
||||
<li><b>latitude</b> (decimal) - Latitude in degrees (optional)</li>
|
||||
<li><b>longitude</b> (decimal) - Longitude in degrees (optional)</li>
|
||||
<li><b>metadata</b> (text) - Metadata for the Channel, which can include JSON, XML, or any other data (optional)</li>
|
||||
<li><b>name</b> (string) - Name of the Channel (optional)</li>
|
||||
<li><b>public_flag</b> (true/false) - Whether the Channel should be public, default false (optional)</li>
|
||||
<li><b>tags</b> (string) - Comma-separated list of tags (optional)</li>
|
||||
<li><b>url</b> (string) - Webpage URL for the Channel (optional)</li>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
Example POST:
|
||||
Example PUT:
|
||||
|
||||
<pre>
|
||||
POST <span class="str"><%= @ssl_api_domain %>update<span class="format format-json">.json</span><span class="format format-xml">.xml</span></span>
|
||||
api_key=<span class="customcode"><%= @channel_api_key %></span>
|
||||
field1=<span class="customcode">73</span>
|
||||
PUT <span class="str"><%= @ssl_api_domain %>channels/<span class="customcode">4</span><span class="format format-json">.json</span><span class="format format-xml">.xml</span></span>
|
||||
api_key=<span class="customcode"><%= @user_api_key %></span>
|
||||
name=<span class="customcode">Updated Channel</span>
|
||||
</pre>
|
||||
|
||||
<br>
|
||||
|
||||
<div class="format format-block-xl format-text">
|
||||
The response will be the entry ID of the update, for example: <code>18</code>
|
||||
<br><br>
|
||||
If the response is <code>0</code> then the update failed.
|
||||
<div class="format format-block-xxl format-text">
|
||||
The response will be a webpage with your updated Channel.
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xl format-json">
|
||||
The response will be a JSON object of the new feed, for example:
|
||||
<div class="format format-block-xxl format-json">
|
||||
The response will be a JSON object of the updated channel, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
{
|
||||
"channel_id": 3,
|
||||
"field1": "73",
|
||||
"field2": null,
|
||||
"field3": null,
|
||||
"field4": null,
|
||||
"field5": null,
|
||||
"field6": null,
|
||||
"field7": null,
|
||||
"field8": null,
|
||||
"created_at": "2014-02-25T14:13:01-05:00",
|
||||
"entry_id": 320,
|
||||
"status": null,
|
||||
"id": 4,
|
||||
"name": "Updated Channel",
|
||||
"description": null,
|
||||
"metadata": null,
|
||||
"latitude": null,
|
||||
"longitude": null,
|
||||
"created_at": "2014-03-25T13:12:50-04:00",
|
||||
"elevation": null,
|
||||
"location":null
|
||||
"last_entry_id": null,
|
||||
"ranking": 15,
|
||||
"username": "hans",
|
||||
"tags": [],
|
||||
"api_keys":
|
||||
[
|
||||
{
|
||||
"api_key": "XXXXXXXXXXXXXXXX",
|
||||
"write_flag": true
|
||||
}
|
||||
]
|
||||
}
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xl format-xml">
|
||||
The response will be an XML object of the new feed, for example:
|
||||
<div class="format format-block-xxl format-xml">
|
||||
The response will be an XML object of the updated channel, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<feed>
|
||||
<channel-id type="integer">3</channel-id>
|
||||
<field1>73</field1>
|
||||
<field2 nil="true"/>
|
||||
<field3 nil="true"/>
|
||||
<field4 nil="true"/>
|
||||
<field5 nil="true"/>
|
||||
<field6 nil="true"/>
|
||||
<field7 nil="true"/>
|
||||
<field8 nil="true"/>
|
||||
<created-at type="dateTime">2014-02-25T14:15:42-05:00</created-at>
|
||||
<entry-id type="integer">321</entry-id>
|
||||
<status nil="true"/>
|
||||
<latitude type="decimal" nil="true"/>
|
||||
<longitude type="decimal" nil="true"/>
|
||||
<elevation nil="true"/>
|
||||
<location nil="true"/>
|
||||
</feed>
|
||||
<channel>
|
||||
<id type="integer">4</id>
|
||||
<name>Updated Channel</name>
|
||||
<description nil="true" />
|
||||
<metadata nil="true" />
|
||||
<latitude type="decimal" nil="true" />
|
||||
<longitude type="decimal" nil="true" />
|
||||
<created-at type="dateTime">2014-03-25T20:17:44-04:00</created-at>
|
||||
<elevation nil="true" />
|
||||
<last-entry-id type="integer" nil="true" />
|
||||
<ranking type="integer">15</ranking>
|
||||
<username>hans</username>
|
||||
<tags type="array" />
|
||||
<api-keys type="array">
|
||||
<api-key>
|
||||
<api-key>XXXXXXXXXXXXXXXX</api-key>
|
||||
<write-flag type="boolean">true</write-flag>
|
||||
</api-key>
|
||||
</api-keys>
|
||||
</channel>
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
100
app/views/docs/channels/_update_feed.html.erb
Normal file
100
app/views/docs/channels/_update_feed.html.erb
Normal file
@ -0,0 +1,100 @@
|
||||
<div>
|
||||
<%= render 'response' %>
|
||||
<h2 id="update_feed">Update Channel Feed</h2>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
To update a Channel feed, send an HTTP GET or POST to<br>
|
||||
<code><%= @ssl_api_domain %>update<span class="format format-json">.json</span><span class="format format-xml">.xml</span></code> .
|
||||
|
||||
<br><br>
|
||||
Valid parameters:
|
||||
<ul>
|
||||
<li><b>api_key</b> (string) - Write API Key for this specific Channel (required). The Write API Key can optionally be sent via an X-THINGSPEAKAPIKEY HTTP header.</li>
|
||||
<li><b>field1</b> (string) - Field 1 data (optional)</li>
|
||||
<li><b>field2</b> (string) - Field 2 data (optional)</li>
|
||||
<li><b>field3</b> (string) - Field 3 data (optional)</li>
|
||||
<li><b>field4</b> (string) - Field 4 data (optional)</li>
|
||||
<li><b>field5</b> (string) - Field 5 data (optional)</li>
|
||||
<li><b>field6</b> (string) - Field 6 data (optional)</li>
|
||||
<li><b>field7</b> (string) - Field 7 data (optional)</li>
|
||||
<li><b>field8</b> (string) - Field 8 data (optional)</li>
|
||||
<li><b>lat</b> (decimal) - Latitude in degrees (optional)</li>
|
||||
<li><b>long</b> (decimal) - Longitude in degrees (optional)</li>
|
||||
<li><b>elevation</b> (integer) - Elevation in meters (optional)</li>
|
||||
<li><b>status</b> (string) - Status update message (optional)</li>
|
||||
<li><b>twitter</b> (string) - Twitter username linked to <a href="/docs/thingtweet">ThingTweet</a> (optional)</li>
|
||||
<li><b>tweet</b> (string) - Twitter status update; see <a href="/docs/thingtweet#update">updating ThingTweet</a> for more info (optional)</li>
|
||||
<li><b>created_at</b> (datetime) - Date when this feed entry was created, in the format<br>YYYY-MM-DD%20HH:NN:SS (optional)</li>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
Example POST:
|
||||
|
||||
<pre>
|
||||
POST <span class="str"><%= @ssl_api_domain %>update<span class="format format-json">.json</span><span class="format format-xml">.xml</span></span>
|
||||
api_key=<span class="customcode"><%= @channel_api_key %></span>
|
||||
field1=<span class="customcode">73</span>
|
||||
</pre>
|
||||
|
||||
<br>
|
||||
|
||||
<div class="format format-block-xl format-text">
|
||||
The response will be the entry ID of the update, for example: <code>18</code>
|
||||
<br><br>
|
||||
If the response is <code>0</code> then the update failed.
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xl format-json">
|
||||
The response will be a JSON object of the new feed, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
{
|
||||
"channel_id": 3,
|
||||
"field1": "73",
|
||||
"field2": null,
|
||||
"field3": null,
|
||||
"field4": null,
|
||||
"field5": null,
|
||||
"field6": null,
|
||||
"field7": null,
|
||||
"field8": null,
|
||||
"created_at": "2014-02-25T14:13:01-05:00",
|
||||
"entry_id": 320,
|
||||
"status": null,
|
||||
"latitude": null,
|
||||
"longitude": null,
|
||||
"elevation": null,
|
||||
"location":null
|
||||
}
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="format format-block-xl format-xml">
|
||||
The response will be an XML object of the new feed, for example:
|
||||
|
||||
<pre class="prettyprint">
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<feed>
|
||||
<channel-id type="integer">3</channel-id>
|
||||
<field1>73</field1>
|
||||
<field2 nil="true"/>
|
||||
<field3 nil="true"/>
|
||||
<field4 nil="true"/>
|
||||
<field5 nil="true"/>
|
||||
<field6 nil="true"/>
|
||||
<field7 nil="true"/>
|
||||
<field8 nil="true"/>
|
||||
<created-at type="dateTime">2014-02-25T14:15:42-05:00</created-at>
|
||||
<entry-id type="integer">321</entry-id>
|
||||
<status nil="true"/>
|
||||
<latitude type="decimal" nil="true"/>
|
||||
<longitude type="decimal" nil="true"/>
|
||||
<elevation nil="true"/>
|
||||
<location nil="true"/>
|
||||
</feed>
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
@ -143,6 +143,25 @@ describe ChannelsController do
|
||||
end
|
||||
end
|
||||
|
||||
describe "update channel" do
|
||||
it 'updates a channel' do
|
||||
post :update, {:id => @channel.id, :key => @user.api_key, :name => 'newname'}
|
||||
response.should be_redirect
|
||||
@channel.reload
|
||||
@channel.name.should eq("newname")
|
||||
channel_id = Channel.all.last.id
|
||||
response.should redirect_to(channel_path(channel_id))
|
||||
end
|
||||
it 'returns JSON' do
|
||||
post :update, {:id => @channel.id, :key => @user.api_key, :name => 'newname', :format => 'json'}
|
||||
JSON.parse(response.body)['name'].should eq("newname")
|
||||
end
|
||||
it 'returns XML' do
|
||||
post :update, {:id => @channel.id, :key => @user.api_key, :name => 'newname', :format => 'xml'}
|
||||
Nokogiri::XML(response.body).css('name').text.should eq("newname")
|
||||
end
|
||||
end
|
||||
|
||||
describe "clear channel" do
|
||||
it 'clears a channel' do
|
||||
@channel.feeds.count.should eq(1)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user