Merge pull request #29 from emre/account_rc_method

Add consider_regeneration to rc calculation

docs/helpers.rst

@@ -147,6 +147,25 @@ If you want the VP at the time the last vote casted, you can pass consider_regen
     print(account.vp())
     print(account.vp(consider_regeneration=False))
 
+Getting resource credits
+-----------------------------------
+This helper method determines the account's resource credits in percent. In default, It considers
+account's regenerated RC. (Actual RC)
+
+If you want the Rc at the time the last vote casted, you can pass consider_regeneration=False.
+
+.. code-block:: python
+
+    from lightsteem.client import Client
+
+    client = Client()
+    account = client.account('emrebeyler')
+
+    print(account.rc())
+    print(account.rc(consider_regeneration=False))
+
+
+
 Getting account reputation
 -----------------------------------
 

lightsteem/helpers/account.py

@@ -212,7 +212,7 @@ def vp(self, consider_regeneration=True, precision=2):
 
         return round(total_vp, precision)
 
-    def rc(self, precision=2):
+    def rc(self, consider_regeneration=True, precision=2):
         preffered_api_type = self.client.api_type
         try:
             rc_info = self.client('rc_api').find_rc_accounts(
@@ -222,6 +222,10 @@ def rc(self, precision=2):
 
             last_mana = int(rc_info["rc_manabar"]["current_mana"])
             max_mana = int(rc_info["max_rc"])
+
+            if not consider_regeneration:
+                # the voting power user has after the last vote they casted.
+                return round(last_mana * 100 / max_mana, precision)
             updated_at = datetime.datetime.utcfromtimestamp(
                 rc_info["rc_manabar"]["last_update_time"])
             diff_in_seconds = (
@@ -233,6 +237,8 @@ def rc(self, precision=2):
 
             return round(current_mana_percent, precision)
 
+            # @todo: should there be some methods to calculate
+            # regeneration estimation until %100?
             # total_mana_required = 100 - current_mana_percent
             # recharge_in_seconds = total_mana_required * \
             #                       VOTING_MANA_REGENERATION_IN_SECONDS / 100

tests.py

@@ -241,6 +241,9 @@ def match_find_rc_accounts(request):
             self.assertEqual(float(95), self.client.account(
                 'emrebeyler').rc())
 
+            self.assertEqual(float(75), self.client.account(
+                'emrebeyler').rc(consider_regeneration=False))
+
     def test_reputation(self):
         reputation_sample = '74765490672156'  # 68.86
         with requests_mock.mock() as m: