rMAL 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46b95f5e3e81314a460fbf51e9acf806c3e1b0d6
-  data.tar.gz: d6036a8dfb970e104edfaacecb8a7d7ce50a6ed9
+  metadata.gz: a02ab8cb0341bd397f199fc400ad58d0d6a89e87
+  data.tar.gz: 28cbd886164e92ed3eb07a9e701bdc5826d35a82
 SHA512:
-  metadata.gz: f8c48d8e4c3bb6b76ce1b4d523b857bb5115a777dfb77a2646fe68ce804fef08c19ee63fc584c831eeb78709420e34a3819914a1d14f024d62216eee4164a6a3
-  data.tar.gz: 2c2eb9a2589f443c87c4ca270bd39aa3063ce96c4cbfb21cf936c7ce239eb46d3c466d65dfc735df15cca37b718e8e807d4de3a5d77bc7243f51797dc0b23222
+  metadata.gz: 4def24973de57061764c92a3c88e283ee3b0230b96b622bbcaa4fd40fde66d62392cb4133b30207eb3fde3a9b35b9cba6d3f805643f3897e6803a2ea4ccbac53
+  data.tar.gz: a17f56c9ba8d86e5b916204f17e6f05f55fa771280ef2e0d3908a6be61e7eca35c567f0736f66258ff5c4dfa767da31641dad8bb57f6e4f0766ef248ea40d094

data/README.md

@@ -4,7 +4,7 @@ MyAnimeList backend Ruby API
 
 ## Under Development
 
-I have recieved my development user agent from MyAnimeList, so I can now continue with development, therefore, a functional (not to mention stable) release of this library is forth-coming.
+This project hasn't even finished adding the basic functionality yet, and so, it is certainly not ready for actual use.
 
 ## Installation
 
@@ -22,7 +22,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+So far, one can do the following.
+
+### Settings
+
+Settings include the username, password and api-key and are all saved in a `settings.yml` file in a directory of choice.
+
+#### Init
+
+```ruby
+RMAL::Settings.init(dir) # dir should be where you want to store your settings (default is "/")
+```
+Note that this stores the directory you've chosen as the global variable `$path`.
+
+#### Set
+
+```ruby
+RMAL::Settings.set(username, password, apikey) # self-explanatory, no defaults
+```
+
+#### Load
+
+```ruby
+RMAL::Settings.load(path) # Load settings, takes path to settings.yml
+```
+This will create the global variables `$w_username`, `$w_password` and `w_apikey`.
+
+### Login
+
+This just verifies credentials.
+```ruby
+RMAL.login
+```
+It'll output your login ID and username.
+
+### Search (Not even remotely complete)
+
+```ruby
+RMAL.search(type, query) # type is manga/anime (default anime), and query is your search query
+```
+So far, this just dumps the entire XML result on you. Parsing comes next.
 
 ## Contributing
 
@@ -34,10 +73,21 @@ TODO: Write usage instructions here
 
 ## Changelog(ue)
 
-### 0.0.1
+### 0.0.3
 
-Just getting it up to wait for MAL development user agent.
+Added functional settings and login functionality, started on search. There seems to be an issue with use:
+```ruby
+# Usage
+RMAL::Settings.init("C:\\Users\\username\\Desktop\\Wherever") # Windows filesystem annoyances
+RMAL::Settings.set("username", "password", "apikey")
+RMAL.login # or search or whatever
+# However, the first two lines seem to be required for execution each time, which they shouldn't. Research into this issue has yet to be started, so hopefully it's trivial.
+```
 
 ### 0.0.2
 
-Updating README and Gemfile for documentation purposes.
+Updating README and Gemfile for documentation purposes.
+
+### 0.0.1
+
+Just getting it up to wait for MAL development user agent.

data/lib/rMAL.rb

@@ -1,5 +1,69 @@
 require "rMAL/version"
+require "yaml"
+require "ox"
 
 module RMAL
-  # Your code goes here...
+	# Configuration of password, username and apikey, for use by other modules
+	module Settings
+		# Create the settings.yml file
+		def self.init(dir = "/") # Default dir may not have the correct access rights granted
+			# Allows user to not bother with the trailing / if so desired
+			if !(dir.end_with? "/")
+				dir = dir + "/"
+			end
+			# Create a settings.yml file
+			File.open("#{dir}settings.yml", "w") do |file|
+			end
+			# Create global path variable for ease of use
+			$path = "#{dir}/settings.yml"
+		end
+		# Allows the user to change the settings where necessary (and rMAL where necessary)
+		def self.set(username, password, apikey)
+			configuration = {
+				'username' => username,
+				'password' => password,
+				'apikey' => apikey
+			}
+			open($path, 'w') { |f| YAML.dump(configuration, f) }
+			open($path) { |f| return f.read }
+		end
+		# Load the settings for use in other modules
+		public # I know this isn't necessary, will remove later
+
+		def self.load(path)
+			# Load the file
+			settings = YAML::load_file path
+			# I am aware of the serious security implications of this eval(). This needs a better fix ASAP.
+			working = eval(settings.inspect)
+			# Load the settings into working variables
+			$w_username = working["username"]
+			$w_password = working["password"]
+			$w_apikey = working["apikey"]
+		end
+	end
+	# Verify Credentials
+	def self.login
+		RMAL::Settings.load($path)
+		# Curl into MAL with the request
+		IO.popen("curl -u #{$w_username}:#{$w_password} http://myanimelist.net/api/account/verify_credentials.xml -A #{$w_apikey}") { |f| $login_response = f.read }
+		# Parse out the user id
+		login_id = Ox.parse($login_response).user.id.text
+		# Parse out the username
+		login_username = Ox.parse($login_response).user.username.text
+		# Display both bits of info
+		puts "Login ID: " + login_id, "Login Username: " + login_username
+		# Return both bits of info
+		return login_id, login_username
+	end
+	# Search anime/manga
+	def self.search(type = "anime", query)
+		RMAL::Settings.load($path)
+		# Replace spaces with '+'s
+		query = query.gsub(/\s/, "+")
+		# Curl into MAL with the request
+		IO.popen("curl -u #{$w_username}:#{$w_password} http://myanimelist.net/api/#{type}/search.xml?q=#{query} -A #{$w_apikey}") { |f| $search_response = f.read }
+		p $search_response # temporary
+	end
 end
+
+# Not done yet

data/lib/rMAL/version.rb

@@ -1,3 +1,3 @@
 module RMAL
-	VERSION = "0.0.2"
+	VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rMAL
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jude Rosen (foogit)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,11 +94,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: MyAnimeList backend Ruby API  (stable release forth-coming)
 test_files:
 - spec/rMAL_spec.rb
 - spec/spec_helper.rb
-has_rdoc: