mmf 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91d04ca8a24c777447c47109eb71c29e6bc316d6
-  data.tar.gz: e9bdb5bbae64ad863dc676221755fa68ab66272a
+  metadata.gz: 577fa4c71578d6efa468ee917c8915f1178e09d3
+  data.tar.gz: c841976f767cd266b2da757bad224b6428794891
 SHA512:
-  metadata.gz: c3a1c12f413800950bedde603a15d49654befe0c6adb2229f7ecdb57086680dfde514b468b5d4f72ca0281cb9e338505946dd83f83fe6146ac32cf122b8e3527
-  data.tar.gz: 7599866ce9c031aa2f04609e3a17965c3292d54f5b97548b033a389c8d66298ec10a1ef21b63d380b09ed7c06ab72068d1da62cbb539b3225895dbdf81dac92c
+  metadata.gz: cf3a43a2456628d03404d5df9475c1de07e770034415b4ffd6648241cd0fd5737ad90b2b2c262ea43b659ed4e4b41f7860927dac3674d395d67c019cc3d85030
+  data.tar.gz: 86a0b1fea879d4961609d50ff4349ef1d827d31a5feac71c20ac4f7add2f273e7dbe1abd29553373cd6a5a666726d81b45d4a2a0f044b32d7e9926e12f50a461

data/README.md

@@ -45,22 +45,43 @@ for details on each API call or use the MapMyFitness [I/O docs](https://develope
 from your browser.
 
 ```text
-client.me           => [get]  v7.0/user/self/?params
-client.workouts     => [get]  v7.0/workout/?params
-client.add_workout  => [post] v7.0/workout/?params
-client.deactivate   => [post] v7.0/user_deactivation/?params
-client.user         => [get]  v7.0/user/:user_id/?params
-client.user_create  => [post] v7.0/user/?params
-client.user_update  => [put]  v7.0/user/:user_id/?params
-client.user_photo   => [get]  v7.0/user_profile_photo/:user_id/?params
-client.user_stats   => [get]  v7.0/user_stats/:user_id/?params
-client.workout      => [get]  v7.0/workout/:workout_id/?params
-client.achievement  => [get]  v7.0/acievement/:achievement_id/?params
-client.achievements => [get]  v7.0/user_acievement/?params
+client.me                     => [get]    v7.0/user/self
+client.deactivate             => [post]   v7.0/user_deactivation
+client.user                   => [get]    v7.0/user/:user_id
+client.create_user            => [post]   v7.0/user
+client.update_user            => [put]    v7.0/user/:user_id
+client.user_photo             => [get]    v7.0/user_profile_photo/:user_id
+client.user_stats             => [get]    v7.0/user_stats/:user_id
+client.achievement            => [get]    v7.0/acievement/:achievement_id
+client.achievements           => [get]    v7.0/user_acievement
+client.friends                => [get]    v7.0/user
+client.suggested_friends      => [get]    v7.0/user
+client.add_friend             => [post]   v7.0/frendship
+client.remove_friend          => [delete] v7.0/friendship/:friendship_id
+client.approve_friend         => [put]    v7.0/friendship/:friendship_id
+client.friend_requests        => [get]    v7.0/friendship
+client.activity_types         => [get]    v7.0/activity_type
+client.activity_type          => [get]    v7.0/activity_type/:activity_type_id
+client.privacy_options        => [get]    v7.0/privacy_option
+client.privacy_option         => [get]    v7.0/privacy_option/:privacy_option_id
+client.add_workout            => [post]   v7.0/workout
+client.workouts               => [get]    v7.0/workout
+client.workout                => [get]    v7.0/workout/:workout_id
+client.course_leaderboard     => [get]    v7.0/course_leaderboard/:course_id
+client.search_courses         => [get]    v7.0/course
+client.course                 => [get]    v7.0/course/:course_id
+client.route                  => [get]    v7.0/route/:route_id
+client.routes                 => [get]    v7.0/route
+client.nearby_routes          => [get]    v7.0/route
+client.add_route              => [post]   v7.0/route
+client.update_route           => [put]    v7.0/route/:route_id
+client.remove_route           => [delete] v7.0/route/:route_id
+client.bookmarks              => [get]    v7.0/route_bookmark
+client.add_bookmark           => [post]   v7.0/route_bookmark/:route_id
+client.remove_bookmark        => [delete] v7.0/route_bookmark/:route_bookmark_id
 ```
 
-All client methods take an optional params hash which is used to build the
-RESTful API endpoint URI.
+All client methods take an optional params hash.
 
 ## Examples
 

data/TODO.md

@@ -0,0 +1,2 @@
+# TODO
+- pagination

data/lib/mmf.rb

@@ -1,6 +1,7 @@
 require "mmf/version"
 require 'oauth2'
 require 'json'
+require 'pp'
 
 class Mmf::Client
   ROOT_URI      = "https://oauth2-api.mapmyapi.com/"
@@ -8,27 +9,60 @@ class Mmf::Client
   VAR     = /%\{(.*?)\}/
   API_MAP = {
     # user resources
-    me:           { method: :get,  endpoint: 'v7.0/user/self' },
-    workouts:     { method: :get,  endpoint: 'v7.0/workout' },
-    add_workout:  { method: :post, endpoint: 'v7.0/workout' },
-    deactivate:   { method: :post, endpoint: 'v7.0/user_deactivation', },
+    me:                 { method: :get,  endpoint: 'v7.0/user/self' },
+    deactivate:         { method: :post, endpoint: 'v7.0/user_deactivation', },
+    user:               { method: :get,  endpoint: 'v7.0/user/%{user_id}', defaults: { user_id: :me } },
+    create_user:        { method: :post, endpoint: 'v7.0/user' },
+    update_user:        { method: :put,  endpoint: 'v7.0/user/%{user_id}', defaults: { user_id: :me } },
+    user_photo:         { method: :get,  endpoint: 'v7.0/user_profile_photo/%{user_id}', defaults: { user_id: :me } },
+    user_stats:         { method: :get,  endpoint: 'v7.0/user_stats/%{user_id}', defaults: { user_id: :me } },
 
-    user:         { method: :get,  endpoint: 'v7.0/user/%{user_id}' },
-    user_create:  { method: :post, endpoint: 'v7.0/user' },
-    user_update:  { method: :put,  endpoint: 'v7.0/user/%{user_id}' },
-    user_photo:   { method: :get,  endpoint: 'v7.0/user_profile_photo/%{user_id}' },
-    user_stats:   { method: :get,  endpoint: 'v7.0/user_stats/%{user_id}' },
+    achievement:        { method: :get,  endpoint: 'v7.0/acievement/%{achievement_id}' },
+    achievements:       { method: :get,  endpoint: 'v7.0/user_acievement', required: [:user], defaults: { user: :me } },
 
-    workout:      { method: :get,  endpoint: 'v7.0/workout/%{workout_id}' },
+    # friend resources
+    friends:            { method: :get,    endpoint: 'v7.0/user', required: [:friends_with] },
+    suggested_friends:  { method: :get,    endpoint: 'v7.0/user', required: [:suggested_friends_for, :suggested_friends_source] },
+    add_friend:         { method: :post,   endpoint: 'v7.0/frendship' },
+    remove_friend:      { method: :delete, endpoint: 'v7.0/friendship/%{friendship_id}' },
+    approve_friend:     { method: :put,    endpoint: 'v7.0/friendship/%{friendship_id}' },
+    friend_requests:    { method: :get,    endpoint: 'v7.0/friendship', required: [:to_user], defaults: { status: 'pending' } },
+
+    # shared resources
+    activity_types:     { method: :get,  endpoint: 'v7.0/activity_type' },
+    activity_type:      { method: :get,  endpoint: 'v7.0/activity_type/%{activity_type_id}' },
+    privacy_options:    { method: :get,  endpoint: 'v7.0/privacy_option' },
+    privacy_option:     { method: :get,  endpoint: 'v7.0/privacy_option/%{privacy_option_id}' },
+
+    # workout resources
+    add_workout:        { method: :post, endpoint: 'v7.0/workout', required: [:activity_type, :name, :start_datetime, :start_locale_timezone] },
+    workouts:           { method: :get,  endpoint: 'v7.0/workout', required: [:user], defaults: { user: :me } },
+    workout:            { method: :get,  endpoint: 'v7.0/workout/%{workout_id}' },
+
+    # course resources
+    search_courses:     { method: :get,  endpoint: 'v7.0/course' },
+    course:             { method: :get,  endpoint: 'v7.0/course/%{course_id}' },
+    # course_leaderboard: { method: :get,  endpoint: 'api/0.1/course_leaderboard/%{course_id}', required: [:activity_type_id] },
+    # course_history:     { method: :get,  endpoint: '/api/0.1/course_history/%{course_id}_%{user_id}' },
+    # course_map:         { method: :get,  endpoint: 'api/0.1/course_map/%{course_id}' },
+
+    # route resources
+    route:              { method: :get,    endpoint: 'v7.0/route/%{route_id}' },
+    routes:             { method: :get,    endpoint: 'v7.0/route', required: [:user], defaults: { user: :me } },
+    nearby_routes:      { method: :get,    endpoint: 'v7.0/route', required: [:close_to_location, :minimum_distance, :maximum_distance] },
+    add_route:          { method: :post,   endpoint: 'v7.0/route' },
+    update_route:       { method: :put,    endpoint: 'v7.0/route/%{route_id}' },
+    remove_route:       { method: :delete, endpoint: 'v7.0/route/%{route_id}' },
+    bookmarks:          { method: :get,    endpoint: 'v7.0/route_bookmark', required: [:user], defaults: { user: :me } },
+    add_bookmark:       { method: :post,   endpoint: 'v7.0/route_bookmark/%{route_id}' },
+    remove_bookmark:    { method: :delete, endpoint: 'v7.0/route_bookmark/%{route_bookmark_id}' }
 
-    achievement:  { method: :get,  endpoint: 'v7.0/acievement/%{achievement_id}' },
-    achievements: { method: :get,  endpoint: 'v7.0/user_acievement' }
   }
 
   attr_accessor :client_key, :client_secret, :access_token
 
   def initialize
-    @client_key, @client_secret, @access_token = ""
+    @client_key, @client_secret, @access_token = '','',''
     yield self
     client  = OAuth2::Client.new(client_key, client_secret)
     @client = OAuth2::AccessToken.new(client, access_token)
@@ -40,35 +74,70 @@ class Mmf::Client
     end
   end
 
+  def user_id
+    @user_id ||= me['id']
+  end
+
   def api
     API_MAP.any? do |name, details|
-      vars = details[:endpoint].scan(VAR).flatten
+      vars = url_params(details[:endpoint])
       context = Hash[vars.zip vars.map {|v| ":#{v}"}]
       endpoint = interpolate(details[:endpoint], context)
-      puts "client.#{name}".ljust(20) + "=> [#{details[:method]}]".ljust(10) + "#{endpoint}/?params"
+      puts "client.#{name}".ljust(30) + "=> [#{details[:method]}]".ljust(12) + endpoint
     end
   end
 
 private
 
   def call(name, params)
-    method = API_MAP[name][:method]
-    endpoint = interpolate(API_MAP[name][:endpoint], params)
-    request(method, endpoint, params)
+    method, endpoint = API_MAP[name].values_at(:method, :endpoint)
+    required = API_MAP[name].fetch(:required, []) + url_params(endpoint).map(&:to_sym)
+    defaults = expand_special(name, API_MAP[name].fetch(:defaults, {}))
+    params   = defaults.merge(params)
+    check_params(name, required, params)
+    begin
+      request(method, interpolate(endpoint, params), params)
+    rescue OAuth2::Error => e
+      raise JSON.parse(e.message[1..-1]).pretty_inspect
+    end
   end
 
   def request(method, endpoint, params)
     uri  = "#{ROOT_URI}/#{endpoint}"
     opts = { params: params, headers: {'Api-Key' => client_key} }
     resp = @client.send(method, uri, opts)
-    JSON.parse(resp.body)
+    find_relevant_data(JSON.parse(resp.body))
+  end
+
+  def find_relevant_data(data)
+    case data
+    when Hash
+      data = data['_embedded'] || data
+      data.size == 1 ? data.first[1] : data
+    else data
+    end
   end
 
   def interpolate(str, context)
-    vars = str.scan(VAR).flatten
+    vars = url_params(str)
     vars.inject(str) do |str, var|
       str.gsub("\%{#{var}}", (context[var.to_sym] || context[var.to_s]).to_s)
     end
   end
 
+  def expand_special(name, params)
+    return params if name == :me
+    params.inject({}) {|h, (k,v)| h[k] = (v == :me ? user_id : v); h }
+  end
+
+  def check_params(name, required, actual)
+    return if required.all? { |p| actual[p] }
+    raise ArgumentError, "Missing one or more required params #{required} for '#{name}' API call. " +
+                         "Check API docs at https://developer.mapmyapi.com/docs for details."
+  end
+
+  def url_params(url)
+    url.scan(VAR).flatten
+  end
+
 end

data/lib/mmf/version.rb

@@ -1,3 +1,3 @@
 module Mmf
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mmf
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alex Skryl
@@ -64,6 +64,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - lib/mmf.rb
 - lib/mmf/version.rb
 - mmf.gemspec
@@ -87,9 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby REST Client for the MapMyFitness API
 test_files: []
-has_rdoc: